Template Spec Versions - Update

Service:

Resource Management

API Version:

2021-05-01

Updates Template Spec Version tags with specified values.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}?api-version=2021-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	Subscription Id which forms part of the URI for every service call.
templateSpecName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Name of the Template Spec.
templateSpecVersion	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	The version of the Template Spec.
api-version	query	True	string	Client Api version.

Request Body

Name	Type	Description
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	TemplateSpecVersion	OK -- Template Spec Version tags are updated.
Other Status Codes	TemplateSpecsError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

TemplateSpecsPatch

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0?api-version=2021-05-01

{
  "tags": {
    "myTag": "My Value"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.templatespecs import TemplateSpecsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-templatespecs
# USAGE
    python template_spec_versions_patch.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = TemplateSpecsClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.template_spec_versions.update(
        resource_group_name="templateSpecRG",
        template_spec_name="simpleTemplateSpec",
        template_spec_version="v1.0",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/templateSpecs/stable/2021-05-01/examples/TemplateSpecVersionsPatch.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0",
  "type": "Microsoft.Resources/templateSpecs/versions",
  "name": "v1.0",
  "location": "eastus",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  },
  "properties": {
    "description": "This is version v1.0 of our template content",
    "mainTemplate": {
      "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
      "contentVersion": "1.0.0.0",
      "parameters": {},
      "resources": []
    }
  },
  "tags": {
    "myTag": "My Value"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	Error Response
LinkedTemplateArtifact	Represents a Template Spec artifact containing an embedded Azure Resource Manager template for use as a linked template.
systemData	Metadata pertaining to creation and last modification of the resource.
TemplateSpecsError	Template Specs error response.
TemplateSpecVersion	Template Spec Version object.
TemplateSpecVersionUpdateModel	Template Spec Version properties to be updated (only tags are currently supported).

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorResponse

Object

Error Response

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

LinkedTemplateArtifact

Object

Represents a Template Spec artifact containing an embedded Azure Resource Manager template for use as a linked template.

Name	Type	Description
path	string	A filesystem safe relative path of the artifact.
template	object	The Azure Resource Manager template.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TemplateSpecsError

Object

Template Specs error response.

Name	Type	Description
error	ErrorResponse	Error Response Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

TemplateSpecVersion

Object

Template Spec Version object.

Name	Type	Description
id	string	String Id used to locate any resource on Azure.
location	string	The location of the Template Spec Version. It must match the location of the parent Template Spec.
name	string	Name of this resource.
properties.description	string maxLength: 4096	Template Spec version description.
properties.linkedTemplates	LinkedTemplateArtifact[]	An array of linked template artifacts.
properties.mainTemplate	object	The main Azure Resource Manager template content.
properties.metadata	object	The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.
properties.uiFormDefinition	object	The Azure Resource Manager template UI definition content.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	Type of this resource.

TemplateSpecVersionUpdateModel

Object

Template Spec Version properties to be updated (only tags are currently supported).

Name	Type	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	Type of this resource.