Share via

Microsoft.Resources tags 2022-09-01

  • Article

Remarks

To learn about applying tags through ARM templates or Bicep files, see Use tags to organize your Azure resources and management hierarchy.

Bicep resource definition

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

resource symbolicname 'Microsoft.Resources/tags@2022-09-01' = {
  scope: resourceSymbolicName or scope
  name: 'default'
  properties: {
    tags: {
      {customized property}: 'string'
    }
  }
}

Property values

Microsoft.Resources/tags

Name Description Value
name The resource name 'default' (required)
properties The set of tags. Tags (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.

Tags

Name Description Value
tags Dictionary of <string> Tags

Tags

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.Resources/tags",
  "apiVersion": "2022-09-01",
  "name": "string",
  "properties": {
    "tags": {
      "{customized property}": "string"
    }
  }
}

Property values

Microsoft.Resources/tags

Name Description Value
apiVersion The api version '2022-09-01'
name The resource name 'default' (required)
properties The set of tags. Tags (required)
type The resource type 'Microsoft.Resources/tags'

Tags

Name Description Value
tags Dictionary of <string> Tags

Tags

Name Description Value

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/tags@2022-09-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      tags = {
        {customized property} = "string"
      }
    }
  })
}

Property values

Microsoft.Resources/tags

Name Description Value
name The resource name 'default' (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties The set of tags. Tags (required)
type The resource type "Microsoft.Resources/tags@2022-09-01"

Tags

Name Description Value
tags Dictionary of <string> Tags

Tags

Name Description Value