Microsoft.Authorization policyDefinitions 2020-09-01

Bicep resource definition

The policyDefinitions 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 policyDefinitions resource type can be deployed with operations that target:

• Management groups - See management group deployment commands
• Subscriptions - See subscription deployment commands

You can reference this resource type as a read-only resource at level of: Tenants

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

Resource format

To create a Microsoft.Authorization/policyDefinitions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Authorization/policyDefinitions@2020-09-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    mode: 'string'
    parameters: {
      {customized property}: {
        allowedValues: [
          any
        ]
        defaultValue: any()
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
          {customized property}: any()
        }
        type: 'string'
      }
    }
    policyRule: any()
    policyType: 'string'
  }
}

Property values

policyDefinitions

PolicyDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy a policy definition and assign to a management group	This template is a management group level template that will create a policy definition and assign that policy to the target management group. Currently, this template cannot be deployed via the Azure Portal.
Deploy a Policy Def and Assign to Multiple Mgmt Groups	This template is a management group level template that will create a policy definition and assign that policy to multiple management groups.
Create an Azure Virtual Network Manager and sample VNETs	This template deploys an Azure Virtual Network Manager and sample virtual networks into the named resource group. It supports multiple connectivity topologies and network group membership types.

ARM template resource definition

The policyDefinitions 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 policyDefinitions resource type can be deployed with operations that target:

• Management groups - See management group deployment commands
• Subscriptions - See subscription deployment commands

You can reference this resource type as a read-only resource at level of: Tenants

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

Resource format

To create a Microsoft.Authorization/policyDefinitions resource, add the following JSON to your template.

{
  "type": "Microsoft.Authorization/policyDefinitions",
  "apiVersion": "2020-09-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "mode": "string",
    "parameters": {
      "{customized property}": {
        "allowedValues": [ object ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string",
          "{customized property}": {}
        },
        "type": "string"
      }
    },
    "policyRule": {},
    "policyType": "string"
  }
}

Property values

policyDefinitions

PolicyDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy a policy definition and assign to a management group	This template is a management group level template that will create a policy definition and assign that policy to the target management group. Currently, this template cannot be deployed via the Azure Portal.
Deploy a Policy Def and Assign to Multiple Mgmt Groups	This template is a management group level template that will create a policy definition and assign that policy to multiple management groups.
Create an Azure Virtual Network Manager and sample VNETs	This template deploys an Azure Virtual Network Manager and sample virtual networks into the named resource group. It supports multiple connectivity topologies and network group membership types.

Terraform (AzAPI provider) resource definition

The policyDefinitions 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 policyDefinitions resource type can be deployed with operations that target:

• Management groups
• Subscriptions

You can reference this resource type as a read-only resource at level of: Tenants

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policyDefinitions@2020-09-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      mode = "string"
      parameters = {
        {customized property} = {
          allowedValues = [ object ]
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          type = "string"
        }
      }
      policyType = "string"
    }
  })
}

Property values

policyDefinitions

PolicyDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata