network_security_perimeter_link_references

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

Overview

Name	network_security_perimeter_link_references
Type	Resource
Id	azure.network.network_security_perimeter_link_references

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.
description	string	A message sent by the remote NSP link admin for connection request. In case of Auto-approved flow, it is default to 'Auto Approved'.
localInboundProfiles	array	Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles.
localOutboundProfiles	array	Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
provisioningState	string	The provisioning state of the NSP LinkReference resource. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "WaitForRemoteCompletion". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, WaitForRemoteCompletion)
remoteInboundProfiles	array	Remote Inbound profile names to which Inbound is allowed. ['*'] value implies inbound is allowed to all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter.
remoteOutboundProfiles	array	Remote Outbound profile names from which Outbound is allowed. ['*'] value implies outbound is allowed from all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter.
remotePerimeterGuid	string	Remote NSP Guid with which the link is created.
remotePerimeterLocation	string	Remote NSP location with which the link gets created.
remotePerimeterResourceId	string	Perimeter ARM Id for the remote NSP with which the link is created.
status	string	The NSP linkReference state. It cannot be changed if link is created in auto-approval mode. Known values are: "Approved", "Pending", "Rejected", and "Disconnected". (Approved, Pending, Rejected, Disconnected)
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.
description	string	A message sent by the remote NSP link admin for connection request. In case of Auto-approved flow, it is default to 'Auto Approved'.
localInboundProfiles	array	Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles.
localOutboundProfiles	array	Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
provisioningState	string	The provisioning state of the NSP LinkReference resource. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "WaitForRemoteCompletion". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, WaitForRemoteCompletion)
remoteInboundProfiles	array	Remote Inbound profile names to which Inbound is allowed. ['*'] value implies inbound is allowed to all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter.
remoteOutboundProfiles	array	Remote Outbound profile names from which Outbound is allowed. ['*'] value implies outbound is allowed from all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter.
remotePerimeterGuid	string	Remote NSP Guid with which the link is created.
remotePerimeterLocation	string	Remote NSP location with which the link gets created.
remotePerimeterResourceId	string	Perimeter ARM Id for the remote NSP with which the link is created.
status	string	The NSP linkReference state. It cannot be changed if link is created in auto-approval mode. Known values are: "Approved", "Pending", "Rejected", and "Disconnected". (Approved, Pending, Rejected, Disconnected)
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, link_reference_name, subscription_id		Gets the specified NSP linkReference resource.
list	select	resource_group_name, network_security_perimeter_name, subscription_id	$top, $skipToken	Lists the NSP LinkReference resources in the specified network security perimeter.
delete	delete	resource_group_name, network_security_perimeter_name, link_reference_name, subscription_id		Deletes an NSP LinkReference resource.

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
link_reference_name	string	The name of the NSP linkReference. 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 linkReference resource.

SELECT
id,
name,
description,
localInboundProfiles,
localOutboundProfiles,
provisioningState,
remoteInboundProfiles,
remoteOutboundProfiles,
remotePerimeterGuid,
remotePerimeterLocation,
remotePerimeterResourceId,
status,
systemData,
type
FROM azure.network.network_security_perimeter_link_references
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' -- required
AND link_reference_name = '{{ link_reference_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the NSP LinkReference resources in the specified network security perimeter.

SELECT
id,
name,
description,
localInboundProfiles,
localOutboundProfiles,
provisioningState,
remoteInboundProfiles,
remoteOutboundProfiles,
remotePerimeterGuid,
remotePerimeterLocation,
remotePerimeterResourceId,
status,
systemData,
type
FROM azure.network.network_security_perimeter_link_references
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 }}'
;

DELETE examples

delete

Deletes an NSP LinkReference resource.

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