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.cognitive_services.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	Information about a linked Network Security Perimeter.
profile	object	Network Security Perimeter Profile Information.
provisioningIssues	array	List of Provisioning Issues.
provisioningState	string	Provisioning state of NetworkSecurityPerimeter configuration.
resourceAssociation	object	Network Security Perimeter Configuration Association Information.
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	Information about a linked Network Security Perimeter.
profile	object	Network Security Perimeter Profile Information.
provisioningIssues	array	List of Provisioning Issues.
provisioningState	string	Provisioning state of NetworkSecurityPerimeter configuration.
resourceAssociation	object	Network Security Perimeter Configuration Association Information.
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, account_name, nsp_configuration_name, subscription_id		Gets the specified NSP configurations for an account.
list	select	resource_group_name, account_name, subscription_id		Gets a list of NSP configurations for an account.
reconcile	exec	resource_group_name, account_name, nsp_configuration_name, subscription_id		Reconcile the NSP configuration for an account.

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
account_name	string	The name of Cognitive Services account. Required.
nsp_configuration_name	string	The name of the NSP Configuration. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified NSP configurations for an account.

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

list

Gets a list of NSP configurations for an account.

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

Lifecycle Methods

reconcile

Reconcile the NSP configuration for an account.

EXEC azure.cognitive_services.network_security_perimeter_configurations.reconcile 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@nsp_configuration_name='{{ nsp_configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;