Share via

Microsoft.Authorization resourceManagementPrivateLinks 2020-05-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Authorization/resourceManagementPrivateLinks@2020-05-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
}

Property Values

Name Description Value
location the region to create private link association. string
name The resource name string (required)
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.

ARM template resource definition

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

{
  "type": "Microsoft.Authorization/resourceManagementPrivateLinks",
  "apiVersion": "2020-05-01",
  "name": "string",
  "location": "string"
}

Property Values

Name Description Value
apiVersion The api version '2020-05-01'
location the region to create private link association. string
name The resource name string (required)
type The resource type 'Microsoft.Authorization/resourceManagementPrivateLinks'

Usage Examples

Terraform (AzAPI provider) resource definition

The resourceManagementPrivateLinks 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/resourceManagementPrivateLinks resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/resourceManagementPrivateLinks@2020-05-01"
  name = "string"
  parent_id = "string"
  location = "string"
}

Property Values

Name Description Value
location the region to create private link association. string
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
type The resource type "Microsoft.Authorization/resourceManagementPrivateLinks@2020-05-01"

Usage Examples

Terraform Samples

A basic example of deploying Resource Management Private Link to restrict access for managing resources in the tenant.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "resourceManagementPrivateLink" {
  type      = "Microsoft.Authorization/resourceManagementPrivateLinks@2020-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
}
  • Last updated on