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.app_configuration.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 network security perimeter (NSP).
profile	object	:vartype profile: ~azure.mgmt.appconfiguration.models.NetworkSecurityProfile
provisioningIssues	array	List of provisioning issues, if any.
provisioningState	string	Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "Canceled". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, Canceled)
resourceAssociation	object	:vartype resource_association: ~azure.mgmt.appconfiguration.models.ResourceAssociation
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_by_configuration_store

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 network security perimeter (NSP).
profile	object	:vartype profile: ~azure.mgmt.appconfiguration.models.NetworkSecurityProfile
provisioningIssues	array	List of provisioning issues, if any.
provisioningState	string	Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "Canceled". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, Canceled)
resourceAssociation	object	:vartype resource_association: ~azure.mgmt.appconfiguration.models.ResourceAssociation
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, config_store_name, network_security_perimeter_configuration_name, subscription_id		Gets the specified network security perimeter configuration associated with the configuration store.
list_by_configuration_store	select	resource_group_name, config_store_name, subscription_id		Lists all network security perimeter configurations for a configuration store.
reconcile	exec	resource_group_name, config_store_name, network_security_perimeter_configuration_name, subscription_id		Forces a refresh of the specified network security perimeter configuration.

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
config_store_name	string	The name of the configuration store. Required.
network_security_perimeter_configuration_name	string	The name of the NetworkSecurityPerimeterConfiguration. 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 network security perimeter configuration associated with the configuration store.

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

list_by_configuration_store

Lists all network security perimeter configurations for a configuration store.

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

Lifecycle Methods

reconcile

Forces a refresh of the specified network security perimeter configuration.

EXEC azure.app_configuration.network_security_perimeter_configurations.reconcile 
@resource_group_name='{{ resource_group_name }}' --required, 
@config_store_name='{{ config_store_name }}' --required, 
@network_security_perimeter_configuration_name='{{ network_security_perimeter_configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;