Microsoft.Resources (stable:2016-07-01)

2025/06/04 • 11 new methods

Deployments_Delete (new)
Description :  Delete deployment.
Reference :  Link ¶

⚼ Request

DELETE:  /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 be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

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

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group to check. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
Deployments_CreateOrUpdate (new)
Description :  Create a named template deployment using a template.
Reference :  Link ¶

⚼ Request

PUT:  /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. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
properties:
{
Description: The deployment properties. ,
Required: False ,
}
{
template:
{
Description: The template content. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink. ,
Required: False ,
}
object ,
templateLink:
{
Description: The template URI. Use only one of Template or TemplateLink. ,
Required: False ,
}
{
uri:
{
Description: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The parameters URI. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
{
uri:
{
Description: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: The debug detail level. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 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 in. ,
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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it 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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: The debug detail level. ,
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 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 in. ,
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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it 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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: The debug detail level. ,
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 :  Get a deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 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 in. ,
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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it 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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: The debug detail level. ,
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 :  Cancel a currently running template deployment.
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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Deployments_Validate (new)
Description :  Validate a deployment template.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
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 ,
parameters:
{
Description: Deployment to validate. ,
Required: True ,
}
{
properties:
{
Description: The deployment properties. ,
Required: False ,
}
{
template:
{
Description: The template content. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink. ,
Required: False ,
}
object ,
templateLink:
{
Description: The template URI. Use only one of Template or TemplateLink. ,
Required: False ,
}
{
uri:
{
Description: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The parameters URI. Use only one of Parameters or ParametersLink. ,
Required: False ,
}
{
uri:
{
Description: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: The debug detail level. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: Validation error. ,
Required: False ,
}
{
code:
{
Description: The error code returned from the server. ,
Required: True ,
}
string ,
message:
{
Description: The error message returned from the server. ,
Required: True ,
}
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 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 in. ,
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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it 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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: The debug detail level. ,
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 from the server. ,
Required: True ,
}
string ,
message:
{
Description: The error message returned from the server. ,
Required: True ,
}
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 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 in. ,
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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it 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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: The debug detail level. ,
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 a deployment template.
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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}
Deployments_List (new)
Description :  Get a list of deployments.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/
{
resourceGroupName:
{
Description: The name of the resource group to filter by. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: Query parameters. If null is passed returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list 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 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 in. ,
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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it 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: URI referencing the template. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included it must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: The debug detail level. ,
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 get the next set of results. ,
Required: False ,
}
string ,
}
DeploymentOperations_Get (new)
Description :  Get a list of deployments operations.
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: Operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 a list of deployments operations.
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. ,
Required: True ,
}
string ,
$top:
{
Description: Query parameters. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of deployments. ,
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 get 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: Client Api Version. ,
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 ,
}
,
]
,
}
,
}