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.hybrid_compute.network_security_perimeter_configurations

Fields

The following fields are returned by SELECT queries:

get_by_private_link_scope

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	The Network Security Perimeter associated with this configuration.
profile	object	Network Security Perimeter profile.
provisioningIssues	array	Provisioning issues.
provisioningState	string	Current state of this NetworkSecurityPerimeter: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.
resourceAssociation	object	The Resource 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_by_private_link_scope

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	The Network Security Perimeter associated with this configuration.
profile	object	Network Security Perimeter profile.
provisioningIssues	array	Provisioning issues.
provisioningState	string	Current state of this NetworkSecurityPerimeter: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.
resourceAssociation	object	The Resource 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_by_private_link_scope	select	resource_group_name, scope_name, perimeter_name, subscription_id		Gets the network security perimeter configuration for a private link scope.
list_by_private_link_scope	select	resource_group_name, scope_name, subscription_id		Lists the network security perimeter configurations for a private link scope.
reconcile_for_private_link_scope	exec	resource_group_name, scope_name, perimeter_name, subscription_id		Forces the network security perimeter configuration to refresh for a private link scope.

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
perimeter_name	string	The name, in the format {perimeterGuid}.{associationName}, of the Network Security Perimeter resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
scope_name	string	The name of the Azure Arc PrivateLinkScope resource. Required.
subscription_id	string

SELECT examples

get_by_private_link_scope

Gets the network security perimeter configuration for a private link scope.

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

list_by_private_link_scope

Lists the network security perimeter configurations for a private link scope.

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

Lifecycle Methods

reconcile_for_private_link_scope

Forces the network security perimeter configuration to refresh for a private link scope.

EXEC azure.hybrid_compute.network_security_perimeter_configurations.reconcile_for_private_link_scope 
@resource_group_name='{{ resource_group_name }}' --required, 
@scope_name='{{ scope_name }}' --required, 
@perimeter_name='{{ perimeter_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;