network_security_perimeter_access_rules

Creates, updates, deletes, gets or lists a network_security_perimeter_access_rules resource.

Overview

Name	network_security_perimeter_access_rules
Type	Resource
Id	azure.network.network_security_perimeter_access_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
addressPrefixes	array	Inbound address prefixes (IPv4/IPv6).
direction	string	Direction that specifies whether the access rules is inbound/outbound. Known values are: "Inbound" and "Outbound". (Inbound, Outbound)
emailAddresses	array	Outbound rules in email address format. This access rule type is currently unavailable for use.
fullyQualifiedDomainNames	array	Outbound rules in fully qualified domain name format.
networkSecurityPerimeters	array	Rule specified by the perimeter id.
phoneNumbers	array	Outbound rules in phone number format. This access rule type is currently unavailable for use.
provisioningState	string	The provisioning state of the scope assignment resource. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", and "Failed". (Succeeded, Creating, Updating, Deleting, Accepted, Failed)
serviceTags	array	Inbound rules of type service tag. This access rule type is currently unavailable for use.
subscriptions	array	List of subscription ids.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
addressPrefixes	array	Inbound address prefixes (IPv4/IPv6).
direction	string	Direction that specifies whether the access rules is inbound/outbound. Known values are: "Inbound" and "Outbound". (Inbound, Outbound)
emailAddresses	array	Outbound rules in email address format. This access rule type is currently unavailable for use.
fullyQualifiedDomainNames	array	Outbound rules in fully qualified domain name format.
networkSecurityPerimeters	array	Rule specified by the perimeter id.
phoneNumbers	array	Outbound rules in phone number format. This access rule type is currently unavailable for use.
provisioningState	string	The provisioning state of the scope assignment resource. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", and "Failed". (Succeeded, Creating, Updating, Deleting, Accepted, Failed)
serviceTags	array	Inbound rules of type service tag. This access rule type is currently unavailable for use.
subscriptions	array	List of subscription ids.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_security_perimeter_name, profile_name, access_rule_name, subscription_id		Gets the specified NSP access rule by name.
list	select	resource_group_name, network_security_perimeter_name, profile_name, subscription_id	$top, $skipToken	Lists the NSP access rules in the specified NSP profile.
create_or_update	insert	resource_group_name, network_security_perimeter_name, profile_name, access_rule_name, subscription_id		Creates or updates a network access rule.
create_or_update	replace	resource_group_name, network_security_perimeter_name, profile_name, access_rule_name, subscription_id		Creates or updates a network access rule.
delete	delete	resource_group_name, network_security_perimeter_name, profile_name, access_rule_name, subscription_id		Deletes an NSP access rule.
reconcile	exec	resource_group_name, network_security_perimeter_name, profile_name, access_rule_name, subscription_id		Reconcile NSP access rules.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
access_rule_name	string	The name of the NSP access rule. Required.
network_security_perimeter_name	string	The name of the network security perimeter. Required.
profile_name	string	The name of the NSP profile. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skipToken	string	SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. Default value is None.
$top	integer	An optional query parameter which specifies the maximum number of records to be returned by the server. Default value is None.

SELECT examples

get

Gets the specified NSP access rule by name.

SELECT
id,
name,
addressPrefixes,
direction,
emailAddresses,
fullyQualifiedDomainNames,
networkSecurityPerimeters,
phoneNumbers,
provisioningState,
serviceTags,
subscriptions,
systemData,
type
FROM azure.network.network_security_perimeter_access_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND access_rule_name = '{{ access_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the NSP access rules in the specified NSP profile.

SELECT
id,
name,
addressPrefixes,
direction,
emailAddresses,
fullyQualifiedDomainNames,
networkSecurityPerimeters,
phoneNumbers,
provisioningState,
serviceTags,
subscriptions,
systemData,
type
FROM azure.network.network_security_perimeter_access_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a network access rule.

INSERT INTO azure.network.network_security_perimeter_access_rules (
properties,
resource_group_name,
network_security_perimeter_name,
profile_name,
access_rule_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_security_perimeter_name }}',
'{{ profile_name }}',
'{{ access_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_security_perimeter_access_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_security_perimeter_access_rules resource.
  - name: network_security_perimeter_name
    value: "{{ network_security_perimeter_name }}"
    description: Required parameter for the network_security_perimeter_access_rules resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the network_security_perimeter_access_rules resource.
  - name: access_rule_name
    value: "{{ access_rule_name }}"
    description: Required parameter for the network_security_perimeter_access_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_security_perimeter_access_rules resource.
  - name: properties
    description: |
      Properties of the NSP access rule.
    value:
      provisioningState: "{{ provisioningState }}"
      direction: "{{ direction }}"
      addressPrefixes:
        - "{{ addressPrefixes }}"
      fullyQualifiedDomainNames:
        - "{{ fullyQualifiedDomainNames }}"
      subscriptions:
        - id: "{{ id }}"
      networkSecurityPerimeters:
        - id: "{{ id }}"
          perimeterGuid: "{{ perimeterGuid }}"
          location: "{{ location }}"
      emailAddresses:
        - "{{ emailAddresses }}"
      phoneNumbers:
        - "{{ phoneNumbers }}"
      serviceTags:
        - "{{ serviceTags }}"

REPLACE examples

create_or_update

Creates or updates a network access rule.

REPLACE azure.network.network_security_perimeter_access_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND access_rule_name = '{{ access_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an NSP access rule.

DELETE FROM azure.network.network_security_perimeter_access_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND access_rule_name = '{{ access_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

reconcile

Reconcile NSP access rules.

EXEC azure.network.network_security_perimeter_access_rules.reconcile 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_security_perimeter_name='{{ network_security_perimeter_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@access_rule_name='{{ access_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;