Share via

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

  • Article

Bicep resource definition

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

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

Remarks

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

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' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    linkedTemplates: [
      {
        path: 'string'
        template: any()
      }
    ]
    mainTemplate: any()
    metadata: any()
    uiFormDefinition: any()
  }
}

Property values

templateSpecs/versions

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location The location of the Template Spec Version. It must match the location of the parent Template Spec. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
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)

TemplateSpecVersionProperties

Name Description Value
description Template Spec version description. string

Constraints:
Max length = 4096
linkedTemplates An array of linked template artifacts. LinkedTemplateArtifact[]
mainTemplate The main Azure Resource Manager template content. For Bicep, you can use the any() function.
metadata The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. For Bicep, you can use the any() function.
uiFormDefinition The Azure Resource Manager template UI definition content. For Bicep, you can use the any() function.

LinkedTemplateArtifact

Name Description Value
path A filesystem safe relative path of the artifact. string (required)
template The Azure Resource Manager template. For Bicep, you can use the any() function.(required)

ARM template resource definition

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

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

Remarks

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

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",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "description": "string",
    "linkedTemplates": [
      {
        "path": "string",
        "template": {}
      }
    ],
    "mainTemplate": {},
    "metadata": {},
    "uiFormDefinition": {}
  }
}

Property values

templateSpecs/versions

Name Description Value
type The resource type 'Microsoft.Resources/templateSpecs/versions'
apiVersion The resource api version '2021-03-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location The location of the Template Spec Version. It must match the location of the parent Template Spec. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Template Spec Version properties. TemplateSpecVersionProperties (required)

TemplateSpecVersionProperties

Name Description Value
description Template Spec version description. string

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

LinkedTemplateArtifact

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

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"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      description = "string"
      linkedTemplates = [
        {
          path = "string"
        }
      ]
    }
  })
}

Property values

templateSpecs/versions

Name Description Value
type The resource type "Microsoft.Resources/templateSpecs/versions@2021-03-01-preview"
name The resource name string (required)
location The location of the Template Spec Version. It must match the location of the parent Template Spec. string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: templateSpecs
tags Resource tags. Dictionary of tag names and values.
properties Template Spec Version properties. TemplateSpecVersionProperties (required)

TemplateSpecVersionProperties

Name Description Value
description Template Spec version description. string

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

LinkedTemplateArtifact

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