Microsoft.Resources templateSpecs 2021-05-01

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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

Remarks

Instead of using an ARM template or Bicep file to define the template spec, we recommend that you use New-AzTemplateSpec in Azure PowerShell or az ts create in Azure CLI to create your template spec. Those commands automatically convert linked templates to artifacts connected to your main template. When you use an ARM template to create the template spec, you must manually add those linked templates as artifacts, which can be complicated. For more information, see Quickstart: Create and deploy template spec.

Resource format

To create a Microsoft.Resources/templateSpecs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Resources/templateSpecs@2021-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
  }
}

Property values

templateSpecs

TemplateSpecProperties

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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

Remarks

Instead of using an ARM template or Bicep file to define the template spec, we recommend that you use New-AzTemplateSpec in Azure PowerShell or az ts create in Azure CLI to create your template spec. Those commands automatically convert linked templates to artifacts connected to your main template. When you use an ARM template to create the template spec, you must manually add those linked templates as artifacts, which can be complicated. For more information, see Quickstart: Create and deploy template spec.

Resource format

To create a Microsoft.Resources/templateSpecs resource, add the following JSON to your template.

{
  "type": "Microsoft.Resources/templateSpecs",
  "apiVersion": "2021-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {}
  }
}

Property values

templateSpecs

TemplateSpecProperties

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/templateSpecs@2021-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
    }
  })
}

Property values

templateSpecs

TemplateSpecProperties