Microsoft.Authorization privateLinkAssociations

  • Article

Bicep resource definition

The privateLinkAssociations resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.

The privateLinkAssociations 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.Authorization/privateLinkAssociations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Authorization/privateLinkAssociations@2020-05-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    privateLink: 'string'
    publicNetworkAccess: 'string'
  }
}

Property values

privateLinkAssociations

Name Description Value
name The resource name string (required)
scope Use when creating an extension resource at a scope that is different than the deployment scope. Target resource

For Bicep, set this property to the symbolic name of the resource to apply the extension resource.
properties The properties of the PrivateLinkAssociation. PrivateLinkAssociationPropertiesOrPrivateLinkAssocia...

PrivateLinkAssociationPropertiesOrPrivateLinkAssocia...

Name Description Value
privateLink The rmpl Resource ID. string
publicNetworkAccess 'Disabled'
'Enabled'

ARM template resource definition

The privateLinkAssociations resource type is an extension resource, which means you can apply it to another resource.

Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.

The privateLinkAssociations 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.Authorization/privateLinkAssociations resource, add the following JSON to your template.

{
  "type": "Microsoft.Authorization/privateLinkAssociations",
  "apiVersion": "2020-05-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "privateLink": "string",
    "publicNetworkAccess": "string"
  }
}

Property values

privateLinkAssociations

Name Description Value
type The resource type 'Microsoft.Authorization/privateLinkAssociations'
apiVersion The resource api version '2020-05-01'
name The resource name string (required)
scope Use when creating an extension resource at a scope that is different than the deployment scope. Target resource

For JSON, set the value to the full name of the resource to apply the extension resource to.
properties The properties of the PrivateLinkAssociation. PrivateLinkAssociationPropertiesOrPrivateLinkAssocia...

PrivateLinkAssociationPropertiesOrPrivateLinkAssocia...

Name Description Value
privateLink The rmpl Resource ID. string
publicNetworkAccess 'Disabled'
'Enabled'

Terraform (AzAPI provider) resource definition

The privateLinkAssociations resource type is an extension resource, which means you can apply it to another resource.

Use the parent_id property on this resource to set the scope for this resource.

The privateLinkAssociations resource type can be deployed with operations that target:

  • Management groups

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

Resource format

To create a Microsoft.Authorization/privateLinkAssociations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/privateLinkAssociations@2020-05-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      privateLink = "string"
      publicNetworkAccess = "string"
    }
  })
}

Property values

privateLinkAssociations

Name Description Value
type The resource type "Microsoft.Authorization/privateLinkAssociations@2020-05-01"
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties The properties of the PrivateLinkAssociation. PrivateLinkAssociationPropertiesOrPrivateLinkAssocia...

PrivateLinkAssociationPropertiesOrPrivateLinkAssocia...

Name Description Value
privateLink The rmpl Resource ID. string
publicNetworkAccess "Disabled"
"Enabled"