network_security_perimeter_configurations

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

Overview

Name	network_security_perimeter_configurations
Type	Resource
Id	azure.event_grid.network_security_perimeter_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
networkSecurityPerimeter	object	Network security perimeter info.
profile	object	Nsp profile configuration, access rules and diagnostic settings.
provisioningIssues	array	Provisioning issues to reflect status when attempting to retrieve nsp profile configuration.
provisioningState	string	Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "Deleted", and "Accepted". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted, Accepted)
resourceAssociation	object	Nsp association name and access mode of association.
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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
networkSecurityPerimeter	object	Network security perimeter info.
profile	object	Nsp profile configuration, access rules and diagnostic settings.
provisioningIssues	array	Provisioning issues to reflect status when attempting to retrieve nsp profile configuration.
provisioningState	string	Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "Deleted", and "Accepted". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted, Accepted)
resourceAssociation	object	Nsp association name and access mode of association.
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, resource_type, resource_name, perimeter_guid, association_name, subscription_id		Get a specific network security perimeter configuration. Get a specific network security perimeter configuration with a topic or domain.
list	select	resource_group_name, resource_type, resource_name, subscription_id		Get all network security perimeter configurations for resource. Get all network security perimeter configurations associated with a topic or domain.
reconcile	exec	resource_group_name, resource_type, resource_name, perimeter_guid, association_name, subscription_id		Reconcile a specific network security perimeter configuration for a given network security perimeter association. Reconcile a specific network security perimeter configuration for a given network security perimeter association with a topic or domain.

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	Association name to association network security perimeter resource to profile. Required.
perimeter_guid	string	Unique identifier for perimeter. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the resource group within the user's subscription. Required.
resource_type	string	The type of the resource. This can be either \'topics\', or \'domains\'. Known values are: "topics" and "domains". Required.
subscription_id	string

SELECT examples

get

Get a specific network security perimeter configuration. Get a specific network security perimeter configuration with a topic or domain.

SELECT
id,
name,
networkSecurityPerimeter,
profile,
provisioningIssues,
provisioningState,
resourceAssociation,
systemData,
type
FROM azure.event_grid.network_security_perimeter_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND perimeter_guid = '{{ perimeter_guid }}' -- required
AND association_name = '{{ association_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all network security perimeter configurations for resource. Get all network security perimeter configurations associated with a topic or domain.

SELECT
id,
name,
networkSecurityPerimeter,
profile,
provisioningIssues,
provisioningState,
resourceAssociation,
systemData,
type
FROM azure.event_grid.network_security_perimeter_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

reconcile

Reconcile a specific network security perimeter configuration for a given network security perimeter association. Reconcile a specific network security perimeter configuration for a given network security perimeter association with a topic or domain.

EXEC azure.event_grid.network_security_perimeter_configurations.reconcile 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_type='{{ resource_type }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@perimeter_guid='{{ perimeter_guid }}' --required, 
@association_name='{{ association_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;