network_security_perimeter_associations

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

Overview

Name	network_security_perimeter_associations
Type	Resource
Id	azure.network.network_security_perimeter_associations

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.
accessMode	string	Access mode on the association. Known values are: "Learning", "Enforced", and "Audit". (Learning, Enforced, Audit)
hasProvisioningIssues	string	Specifies if there are provisioning issues.
privateLinkResource	object	Reference to another subresource.
profile	object	Reference to another subresource.
provisioningState	string	The provisioning state of the resource association resource. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", and "Failed". (Succeeded, Creating, Updating, Deleting, Accepted, Failed)
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.
accessMode	string	Access mode on the association. Known values are: "Learning", "Enforced", and "Audit". (Learning, Enforced, Audit)
hasProvisioningIssues	string	Specifies if there are provisioning issues.
privateLinkResource	object	Reference to another subresource.
profile	object	Reference to another subresource.
provisioningState	string	The provisioning state of the resource association resource. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", and "Failed". (Succeeded, Creating, Updating, Deleting, Accepted, Failed)
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, association_name, subscription_id		Gets the specified NSP association by name.
list	select	resource_group_name, network_security_perimeter_name, subscription_id	$top, $skipToken	Lists the NSP resource associations.
create_or_update	insert	resource_group_name, network_security_perimeter_name, association_name, subscription_id		Creates or updates a NSP resource association.
create_or_update	replace	resource_group_name, network_security_perimeter_name, association_name, subscription_id		Creates or updates a NSP resource association.
delete	delete	resource_group_name, network_security_perimeter_name, association_name, subscription_id		Deletes an NSP association resource.
reconcile	exec	resource_group_name, network_security_perimeter_name, association_name, subscription_id		Reconcile NSP association.

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
association_name	string	The name of the NSP association. Required.
network_security_perimeter_name	string	The name of the network security perimeter. 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 association by name.

SELECT
id,
name,
accessMode,
hasProvisioningIssues,
privateLinkResource,
profile,
provisioningState,
systemData,
type
FROM azure.network.network_security_perimeter_associations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' -- required
AND association_name = '{{ association_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the NSP resource associations.

SELECT
id,
name,
accessMode,
hasProvisioningIssues,
privateLinkResource,
profile,
provisioningState,
systemData,
type
FROM azure.network.network_security_perimeter_associations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a NSP resource association.

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

Manifest

# Description fields are for documentation purposes
- name: network_security_perimeter_associations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_security_perimeter_associations resource.
  - name: network_security_perimeter_name
    value: "{{ network_security_perimeter_name }}"
    description: Required parameter for the network_security_perimeter_associations resource.
  - name: association_name
    value: "{{ association_name }}"
    description: Required parameter for the network_security_perimeter_associations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_security_perimeter_associations resource.
  - name: properties
    description: |
      Properties of the NSP resource association.
    value:
      provisioningState: "{{ provisioningState }}"
      privateLinkResource:
        id: "{{ id }}"
      profile:
        id: "{{ id }}"
      accessMode: "{{ accessMode }}"
      hasProvisioningIssues: "{{ hasProvisioningIssues }}"

REPLACE examples

create_or_update

Creates or updates a NSP resource association.

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

DELETE examples

delete

Deletes an NSP association resource.

DELETE FROM azure.network.network_security_perimeter_associations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' --required
AND association_name = '{{ association_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

reconcile

Reconcile NSP association.

EXEC azure.network.network_security_perimeter_associations.reconcile 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_security_perimeter_name='{{ network_security_perimeter_name }}' --required, 
@association_name='{{ association_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;