network_security_perimeter_links

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

Overview

Name	network_security_perimeter_links
Type	Resource
Id	azure.network.network_security_perimeter_links

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.
autoApprovedRemotePerimeterResourceId	string	Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.
description	string	A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
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 Link 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. Use ['*'] to allow inbound to all profiles. This property can only be updated in auto-approval mode.
remoteOutboundProfiles	array	Remote 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.
remotePerimeterGuid	string	Remote NSP Guid with which the link gets created.
remotePerimeterLocation	string	Remote NSP location with which the link gets created.
status	string	The NSP link state. 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.
autoApprovedRemotePerimeterResourceId	string	Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.
description	string	A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
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 Link 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. Use ['*'] to allow inbound to all profiles. This property can only be updated in auto-approval mode.
remoteOutboundProfiles	array	Remote 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.
remotePerimeterGuid	string	Remote NSP Guid with which the link gets created.
remotePerimeterLocation	string	Remote NSP location with which the link gets created.
status	string	The NSP link state. 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_name, subscription_id		Gets the specified NSP link resource.
list	select	resource_group_name, network_security_perimeter_name, subscription_id	$top, $skipToken	Lists the NSP Link resources in the specified network security perimeter.
create_or_update	insert	resource_group_name, network_security_perimeter_name, link_name, subscription_id		Creates or updates NSP link resource.
create_or_update	replace	resource_group_name, network_security_perimeter_name, link_name, subscription_id		Creates or updates NSP link resource.
delete	delete	resource_group_name, network_security_perimeter_name, link_name, subscription_id		Deletes an NSP Link 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_name	string	The name of the NSP link. 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 link resource.

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

list

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

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

INSERT examples

create_or_update

Creates or updates NSP link resource.

INSERT INTO azure.network.network_security_perimeter_links (
properties,
resource_group_name,
network_security_perimeter_name,
link_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_security_perimeter_name }}',
'{{ link_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_security_perimeter_links
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_security_perimeter_links resource.
  - name: network_security_perimeter_name
    value: "{{ network_security_perimeter_name }}"
    description: Required parameter for the network_security_perimeter_links resource.
  - name: link_name
    value: "{{ link_name }}"
    description: Required parameter for the network_security_perimeter_links resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_security_perimeter_links resource.
  - name: properties
    description: |
      Properties of the network security perimeter link resource.
    value:
      provisioningState: "{{ provisioningState }}"
      autoApprovedRemotePerimeterResourceId: "{{ autoApprovedRemotePerimeterResourceId }}"
      remotePerimeterGuid: "{{ remotePerimeterGuid }}"
      remotePerimeterLocation: "{{ remotePerimeterLocation }}"
      localInboundProfiles:
        - "{{ localInboundProfiles }}"
      localOutboundProfiles:
        - "{{ localOutboundProfiles }}"
      remoteInboundProfiles:
        - "{{ remoteInboundProfiles }}"
      remoteOutboundProfiles:
        - "{{ remoteOutboundProfiles }}"
      description: "{{ description }}"
      status: "{{ status }}"

REPLACE examples

create_or_update

Creates or updates NSP link resource.

REPLACE azure.network.network_security_perimeter_links
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' --required
AND link_name = '{{ link_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an NSP Link resource.

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