Microsoft.Resources (preview:2021-03-01)

2025/06/04 • 11 new, 11 deleted methods

TemplateSpecs_CreateOrUpdate (new)
Description :  Creates or updates a Template Spec.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpec:
{
Description: Template Spec supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_Update (new)
Description :  Updates Template Spec tags with specified values.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpec:
{
Description: Template Spec resource with the tags to be updated. ,
Required: False ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_Get (new)
Description :  Gets a Template Spec with a given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
$expand:
{
Description: Allows for expansion of additional Template Spec details in the response. Optional. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_Delete (new)
Description :  Deletes a Template Spec by name. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_ListBySubscription (new)
Description :  Lists all the Template Specs within the specified subscriptions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/templateSpecs/
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
$expand:
{
Description: Allows for expansion of additional Template Spec details in the response. Optional. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Template Specs. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_ListByResourceGroup (new)
Description :  Lists all the Template Specs within the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$expand:
{
Description: Allows for expansion of additional Template Spec details in the response. Optional. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Template Specs. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_CreateOrUpdate (new)
Description :  Creates or updates a Template Spec version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
templateSpecVersion:
{
Description: The version of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpecVersionModel:
{
Description: Template Spec Version supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_Update (new)
Description :  Updates Template Spec Version tags with specified values.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpecVersion:
{
Description: The version of the Template Spec. ,
Required: True ,
}
string ,
templateSpecVersionUpdateModel:
{
Description: Template Spec Version resource with the tags to be updated. ,
Required: False ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_Get (new)
Description :  Gets a Template Spec version from a specific Template Spec.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpecVersion:
{
Description: The version of the Template Spec. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_Delete (new)
Description :  Deletes a specific version from a Template Spec. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpecVersion:
{
Description: The version of the Template Spec. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_List (new)
Description :  Lists all the Template Spec versions in the specified Template Spec.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Template Spec versions. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_CreateOrUpdate (removed)
Description :  Creates or updates a Template Spec.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpec:
{
Description: Template Spec supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_Update (removed)
Description :  Updates Template Spec tags with specified values.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpec:
{
Description: Template Spec resource with the tags to be updated. ,
Required: False ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_Get (removed)
Description :  Gets a Template Spec with a given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
$expand:
{
Description: Allows for expansion of additional Template Spec details in the response. Optional. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_Delete (removed)
Description :  Deletes a Template Spec by name. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_ListBySubscription (removed)
Description :  Lists all the Template Specs within the specified subscriptions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/templateSpecs/
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
$expand:
{
Description: Allows for expansion of additional Template Spec details in the response. Optional. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Template Specs. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecs_ListByResourceGroup (removed)
Description :  Lists all the Template Specs within the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$expand:
{
Description: Allows for expansion of additional Template Spec details in the response. Optional. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Template Specs. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec properties. ,
Required: False ,
}
{
description:
{
Description: Template Spec description. ,
Required: False ,
}
string ,
displayName:
{
Description: Template Spec display name. ,
Required: False ,
}
string ,
metadata:
{
Description: The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
versions:
{
Description: High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_CreateOrUpdate (removed)
Description :  Creates or updates a Template Spec version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
templateSpecVersion:
{
Description: The version of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpecVersionModel:
{
Description: Template Spec Version supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_Update (removed)
Description :  Updates Template Spec Version tags with specified values.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpecVersion:
{
Description: The version of the Template Spec. ,
Required: True ,
}
string ,
templateSpecVersionUpdateModel:
{
Description: Template Spec Version resource with the tags to be updated. ,
Required: False ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_Get (removed)
Description :  Gets a Template Spec version from a specific Template Spec.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpecVersion:
{
Description: The version of the Template Spec. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_Delete (removed)
Description :  Deletes a specific version from a Template Spec. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
templateSpecVersion:
{
Description: The version of the Template Spec. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TemplateSpecVersions_List (removed)
Description :  Lists all the Template Spec versions in the specified Template Spec.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions
{
subscriptionId:
{
Description: Subscription Id which forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
templateSpecName:
{
Description: Name of the Template Spec. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Template Spec versions. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Template Spec Version. It must match the location of the parent Template Spec. ,
Required: True ,
}
string ,
properties:
{
Description: Template Spec Version properties. ,
Required: True ,
}
{
description:
{
Description: Template Spec version description. ,
Required: False ,
}
string ,
linkedTemplates:
{
Description: An array of linked template artifacts. ,
Required: False ,
}
[
{
path:
{
Description: A filesystem safe relative path of the artifact. ,
Required: True ,
}
string ,
template:
{
Description: The Azure Resource Manager template. ,
Required: True ,
}
object ,
}
,
]
,
metadata:
{
Description: The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs. ,
Required: False ,
}
object ,
mainTemplate:
{
Description: The main Azure Resource Manager template content. ,
Required: False ,
}
object ,
uiFormDefinition:
{
Description: The Azure Resource Manager template UI definition content. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}