Microsoft.Resources templateSpecs/versions 2021-03-01-preview

• Latest
• 2022-02-01
• 2021-05-01
• 2021-03-01-preview
• 2019-06-01-preview

Remarks

For information about creating portal forms, see Tutorial: Create Azure portal forms for a template spec.

Bicep resource definition

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

resource symbolicname 'Microsoft.Resources/templateSpecs/versions@2021-03-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    linkedTemplates: [
      {
        path: 'string'
        template: any(Azure.Bicep.Types.Concrete.AnyType)
      }
    ]
    mainTemplate: any(Azure.Bicep.Types.Concrete.AnyType)
    metadata: any(Azure.Bicep.Types.Concrete.AnyType)
    uiFormDefinition: any(Azure.Bicep.Types.Concrete.AnyType)
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

LinkedTemplateArtifact

Name	Description	Value
path	A filesystem safe relative path of the artifact.	string (required)
template	The Azure Resource Manager template.	any (required)

Microsoft.Resources/templateSpecs/versions

Name	Description	Value
location	The location of the Template Spec Version. It must match the location of the parent Template Spec.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: templateSpecs
properties	Template Spec Version properties.	TemplateSpecVersionProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

TemplateSpecVersionProperties

Name	Description	Value
description	Template Spec version description.	string Constraints: Max length =
linkedTemplates	An array of linked template artifacts.	LinkedTemplateArtifact[]
mainTemplate	The main Azure Resource Manager template content.	any
metadata	The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.	any
uiFormDefinition	The Azure Resource Manager template UI definition content.	any

TemplateSpecVersionTags

Name	Description	Value

ARM template resource definition

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

{
  "type": "Microsoft.Resources/templateSpecs/versions",
  "apiVersion": "2021-03-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "linkedTemplates": [
      {
        "path": "string",
        "template": {}
      }
    ],
    "mainTemplate": {},
    "metadata": {},
    "uiFormDefinition": {}
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

LinkedTemplateArtifact

Name	Description	Value
path	A filesystem safe relative path of the artifact.	string (required)
template	The Azure Resource Manager template.	any (required)

Microsoft.Resources/templateSpecs/versions

Name	Description	Value
apiVersion	The api version	'2021-03-01-preview'
location	The location of the Template Spec Version. It must match the location of the parent Template Spec.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required)
properties	Template Spec Version properties.	TemplateSpecVersionProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Resources/templateSpecs/versions'

TemplateSpecVersionProperties

Name	Description	Value
description	Template Spec version description.	string Constraints: Max length =
linkedTemplates	An array of linked template artifacts.	LinkedTemplateArtifact[]
mainTemplate	The main Azure Resource Manager template content.	any
metadata	The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.	any
uiFormDefinition	The Azure Resource Manager template UI definition content.	any

TemplateSpecVersionTags

Name	Description	Value

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/templateSpecs/versions@2021-03-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      description = "string"
      linkedTemplates = [
        {
          path = "string"
          template = ?
        }
      ]
      mainTemplate = ?
      metadata = ?
      uiFormDefinition = ?
    }
  })
}

Property values

LinkedTemplateArtifact

Name	Description	Value
path	A filesystem safe relative path of the artifact.	string (required)
template	The Azure Resource Manager template.	any (required)

Microsoft.Resources/templateSpecs/versions

Name	Description	Value
location	The location of the Template Spec Version. It must match the location of the parent Template Spec.	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: templateSpecs
properties	Template Spec Version properties.	TemplateSpecVersionProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Resources/templateSpecs/versions@2021-03-01-preview"

TemplateSpecVersionProperties

Name	Description	Value
description	Template Spec version description.	string Constraints: Max length =
linkedTemplates	An array of linked template artifacts.	LinkedTemplateArtifact[]
mainTemplate	The main Azure Resource Manager template content.	any
metadata	The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.	any
uiFormDefinition	The Azure Resource Manager template UI definition content.	any

TemplateSpecVersionTags

Name	Description	Value