Microsoft.Resources templateSpecs
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.
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.
Resource format
To create a Microsoft.Resources/templateSpecs resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Resources/templateSpecs@2022-02-01' = {
location: 'string'
name: 'string'
properties: {
description: 'string'
displayName: 'string'
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
}
tags: {
{customized property}: 'string'
}
}
Property values
Microsoft.Resources/templateSpecs
| Name | Description | Value |
|---|---|---|
| location | The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required) |
| properties | Template Spec properties. | TemplateSpecProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
TemplateSpecProperties
| Name | Description | Value |
|---|---|---|
| description | Template Spec description. | string Constraints: Max length = |
| displayName | Template Spec display name. | string Constraints: Max length = |
| metadata | The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. | any |
TemplateSpecTags
| Name | Description | Value |
|---|
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.
Resource format
To create a Microsoft.Resources/templateSpecs resource, add the following JSON to your template.
{
"type": "Microsoft.Resources/templateSpecs",
"apiVersion": "2022-02-01",
"name": "string",
"location": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {}
},
"tags": {
"{customized property}": "string"
}
}
Property values
Microsoft.Resources/templateSpecs
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-02-01' |
| location | The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required) |
| properties | Template Spec properties. | TemplateSpecProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Resources/templateSpecs' |
TemplateSpecProperties
| Name | Description | Value |
|---|---|---|
| description | Template Spec description. | string Constraints: Max length = |
| displayName | Template Spec display name. | string Constraints: Max length = |
| metadata | The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. | any |
TemplateSpecTags
| Name | Description | Value |
|---|
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@2022-02-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
description = "string"
displayName = "string"
metadata = ?
}
})
}
Property values
Microsoft.Resources/templateSpecs
| Name | Description | Value |
|---|---|---|
| location | The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required) |
| properties | Template Spec properties. | TemplateSpecProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Resources/templateSpecs@2022-02-01" |
TemplateSpecProperties
| Name | Description | Value |
|---|---|---|
| description | Template Spec description. | string Constraints: Max length = |
| displayName | Template Spec display name. | string Constraints: Max length = |
| metadata | The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. | any |
TemplateSpecTags
| Name | Description | Value |
|---|