Microsoft.Resources (stable:2017-05-10)

2025/06/04 • 11 new methods

Deployments_Delete (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group with the deployment to delete. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Deployments_CheckExistence (new)
Description :  Checks whether the deployment exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group with the deployment to check. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment to check. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
Deployments_CreateOrUpdate (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
template:
{
Description: The template content. Use only one of Template or TemplateLink. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI referencing the template. Use only one of Template or TemplateLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
error:
{
Description: The deployment error. ,
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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
template:
{
Description: The template content. Use only one of Template or TemplateLink. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI referencing the template. Use only one of Template or TemplateLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
error:
{
Description: The deployment error. ,
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 ,
}
,
]
,
}
,
}
,
}
Deployments_Get (new)
Description :  Gets a deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
template:
{
Description: The template content. Use only one of Template or TemplateLink. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI referencing the template. Use only one of Template or TemplateLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
error:
{
Description: The deployment error. ,
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 ,
}
,
]
,
}
,
}
,
}
Deployments_Cancel (new)
Description :  You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment to cancel. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Deployments_Validate (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
resourceGroupName:
{
Description: The name of the resource group the template will be deployed to. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: Validation error. ,
Required: False ,
}
{
code:
{
Description: The error code returned when exporting the template. ,
Required: False ,
}
string ,
message:
{
Description: The error message describing the export error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Validation error. ,
Required: False ,
}
[
string ,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
template:
{
Description: The template content. Use only one of Template or TemplateLink. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI referencing the template. Use only one of Template or TemplateLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
error:
{
Description: The deployment error. ,
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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (400)

{
error:
{
Description: Validation error. ,
Required: False ,
}
{
code:
{
Description: The error code returned when exporting the template. ,
Required: False ,
}
string ,
message:
{
Description: The error message describing the export error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Validation error. ,
Required: False ,
}
[
string ,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
template:
{
Description: The template content. Use only one of Template or TemplateLink. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI referencing the template. Use only one of Template or TemplateLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
error:
{
Description: The deployment error. ,
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 ,
}
,
]
,
}
,
}
,
}
Deployments_ExportTemplate (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment from which to get the template. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}
Deployments_ListByResourceGroup (new)
Description :  Get all the deployments for a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/
{
resourceGroupName:
{
Description: The name of the resource group with the deployments to get. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to get. If null is passed, returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployments. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
template:
{
Description: The template content. Use only one of Template or TemplateLink. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI referencing the template. Use only one of Template or TemplateLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. ,
Required: False ,
}
string ,
}
,
error:
{
Description: The deployment error. ,
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 ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
DeploymentOperations_Get (new)
Description :  Gets a deployments operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of the operation to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message. ,
Required: False ,
}
string ,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}
DeploymentOperations_List (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment with the operation to get. ,
Required: True ,
}
string ,
$top:
{
Description: The number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment operations. ,
Required: False ,
}
[
{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message. ,
Required: False ,
}
string ,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Deployments_CalculateTemplateHash (new)
Description :  Calculate the hash of the given template.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/calculateTemplateHash
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
template:
{
Description: The template provided to calculate hash. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
minifiedTemplate:
{
Description: The minified template string. ,
Required: False ,
}
string ,
templateHash:
{
Description: The template hash. ,
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 ,
}
,
]
,
}
,
}