Microsoft.Network networkSecurityPerimeters/links 2021-02-01-preview

  • Article

Bicep resource definition

The networkSecurityPerimeters/links resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/networkSecurityPerimeters/links resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/networkSecurityPerimeters/links@2021-02-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    autoApprovedRemotePerimeterResourceId: 'string'
    description: 'string'
    localInboundProfiles: [
      'string'
    ]
    remoteInboundProfiles: [
      'string'
    ]
  }
}

Property values

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: networkSecurityPerimeters
properties Properties of the network security perimeter link resource. NspLinkProperties

NspLinkProperties

Name Description Value
autoApprovedRemotePerimeterResourceId 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. string
description 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. string
localInboundProfiles Local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is ['']. string[]
remoteInboundProfiles 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. It's default value is ['']. string[]

ARM template resource definition

The networkSecurityPerimeters/links resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/networkSecurityPerimeters/links resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/networkSecurityPerimeters/links",
  "apiVersion": "2021-02-01-preview",
  "name": "string",
  "properties": {
    "autoApprovedRemotePerimeterResourceId": "string",
    "description": "string",
    "localInboundProfiles": [ "string" ],
    "remoteInboundProfiles": [ "string" ]
  }
}

Property values

Name Description Value
type The resource type 'Microsoft.Network/networkSecurityPerimeters/links'
apiVersion The resource api version '2021-02-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Properties of the network security perimeter link resource. NspLinkProperties

NspLinkProperties

Name Description Value
autoApprovedRemotePerimeterResourceId 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. string
description 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. string
localInboundProfiles Local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is ['']. string[]
remoteInboundProfiles 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. It's default value is ['']. string[]

Terraform (AzAPI provider) resource definition

The networkSecurityPerimeters/links resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/networkSecurityPerimeters/links resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkSecurityPerimeters/links@2021-02-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      autoApprovedRemotePerimeterResourceId = "string"
      description = "string"
      localInboundProfiles = [
        "string"
      ]
      remoteInboundProfiles = [
        "string"
      ]
    }
  })
}

Property values

Name Description Value
type The resource type "Microsoft.Network/networkSecurityPerimeters/links@2021-02-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: networkSecurityPerimeters
properties Properties of the network security perimeter link resource. NspLinkProperties

NspLinkProperties

Name Description Value
autoApprovedRemotePerimeterResourceId 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. string
description 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. string
localInboundProfiles Local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is ['']. string[]
remoteInboundProfiles 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. It's default value is ['']. string[]