Microsoft.Resources (stable:2024-03-01)

2025/06/04 • 73 new, 18 deleted methods

DeploymentStacks_ListAtResourceGroup (new)
Description :  Lists all the Deployment stacks within the specified Resource Group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Deployment stacks. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ListAtSubscription (new)
Description :  Lists all the Deployment stacks within the specified Subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Deployment stacks. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ListAtManagementGroup (new)
Description :  Lists all the Deployment stacks within the specified Management Group.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Deployment stacks. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_CreateOrUpdateAtResourceGroup (new)
Description :  Creates or updates a Deployment stack at Resource Group scope.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_GetAtResourceGroup (new)
Description :  Gets a Deployment stack with a given name at Resource Group scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_DeleteAtResourceGroup (new)
Description :  Deletes a Deployment stack by name at Resource Group scope. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for unmanaged resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged resource groups. ,
Required: False ,
}
string ,
unmanageAction.ManagementGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged management groups. ,
Required: False ,
}
string ,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_CreateOrUpdateAtSubscription (new)
Description :  Creates or updates a Deployment stack at Subscription scope.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_GetAtSubscription (new)
Description :  Gets a Deployment stack with a given name at Subscription scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_DeleteAtSubscription (new)
Description :  Deletes a Deployment stack by name at Subscription scope. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for unmanaged resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged resource groups. ,
Required: False ,
}
string ,
unmanageAction.ManagementGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged management groups. ,
Required: False ,
}
string ,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_CreateOrUpdateAtManagementGroup (new)
Description :  Creates or updates a Deployment stack at Management Group scope.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_GetAtManagementGroup (new)
Description :  Gets a Deployment stack with a given name at Management Group scope.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_DeleteAtManagementGroup (new)
Description :  Deletes a Deployment stack by name at Management Group scope. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for unmanaged resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged resource groups. ,
Required: False ,
}
string ,
unmanageAction.ManagementGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged management groups. ,
Required: False ,
}
string ,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ExportTemplateAtResourceGroup (new)
Description :  Exports the template used to create the Deployment stack at Resource Group scope.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. Use this element 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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ExportTemplateAtSubscription (new)
Description :  Exports the template used to create the Deployment stack at Subscription scope.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. Use this element 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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ExportTemplateAtManagementGroup (new)
Description :  Exports the template used to create the Deployment stack at Management Group scope.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. Use this element 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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ValidateStackAtResourceGroup (new)
Description :  Runs preflight validation on the Resource Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/validate
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack to validate. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (400)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ValidateStackAtSubscription (new)
Description :  Runs preflight validation on the Subscription scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/validate
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack to validate. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (400)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ValidateStackAtManagementGroup (new)
Description :  Runs preflight validation on the Management Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/validate
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack to validate. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (400)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
Deployments_DeleteAtScope (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. 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:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

HEAD:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdateAtScope (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CancelAtScope (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 resources partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtScope (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (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 ,
}
,
]
,
}
,
}
Deployments_ExportTemplateAtScope (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/
{
scope:
{
Description: The resource scope. ,
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 ,
}

⚐ 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: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_DeleteAtTenantScope (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. 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:  /providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

HEAD:  /providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdateAtTenantScope (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CancelAtTenantScope (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 resources partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtTenantScope (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (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 ,
}
,
]
,
}
,
}
Deployments_WhatIfAtTenantScope (new)
Description :  Returns changes that will be made by the deployment if executed at the scope of the tenant group.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
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 (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
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 ,
}
,
]
,
}
,
}
Deployments_ExportTemplateAtTenantScope (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Resources/deployments/
{
$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 ,
}

⚐ 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: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_DeleteAtManagementGroupScope (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. 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:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

HEAD:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdateAtManagementGroupScope (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CancelAtManagementGroupScope (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 resources partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtManagementGroupScope (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (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 ,
}
,
]
,
}
,
}
Deployments_WhatIfAtManagementGroupScope (new)
Description :  Returns changes that will be made by the deployment if executed at the scope of the management group.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
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 (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
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 ,
}
,
]
,
}
,
}
Deployments_ExportTemplateAtManagementGroupScope (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/
{
groupId:
{
Description: The management group ID. ,
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 ,
}

⚐ 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: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_DeleteAtSubscriptionScope (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. 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}/providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdateAtSubscriptionScope (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CancelAtSubscriptionScope (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 resources partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtSubscriptionScope (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (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 ,
}
,
]
,
}
,
}
Deployments_WhatIfAtSubscriptionScope (new)
Description :  Returns changes that will be made by the deployment if executed at the scope of the subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to What If. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
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 (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
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 ,
}
,
]
,
}
,
}
Deployments_ExportTemplateAtSubscriptionScope (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/
{
$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 Microsoft Azure subscription ID. ,
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: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
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 ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (202)

{}

⚐ Response (400)

{
error:
{
Description: The deployment validation 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 ,
}
,
]
,
}
,
properties:
{
Description: The template deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 (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 ,
}
,
]
,
}
,
}
Deployments_WhatIf (new)
Description :  Returns changes that will be made by the deployment if executed at the scope of the resource group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
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 ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
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 (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
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 ,
}
,
]
,
}
,
}
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 Microsoft Azure subscription ID. ,
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: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the template deployment. ,
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 resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource 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 ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
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 ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
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 ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
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 ,
}
,
]
,
}
,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}
{
scope:
{
Description: The resource scope. ,
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 ,
}

⚐ 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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DeploymentOperations_ListAtScope (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
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 ,
}

⚐ 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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}

⚐ 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 ,
}
,
]
,
}
,
}
DeploymentOperations_GetAtTenantScope (new)
Description :  Gets a deployments operation.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}
{
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 ,
}

⚐ 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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DeploymentOperations_ListAtTenantScope (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Resources/deployments/{deploymentName}/operations
{
deploymentName:
{
Description: The name of the deployment. ,
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 ,
}

⚐ 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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}

⚐ 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 ,
}
,
]
,
}
,
}
DeploymentOperations_GetAtManagementGroupScope (new)
Description :  Gets a deployments operation.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}
{
groupId:
{
Description: The management group ID. ,
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 ,
}

⚐ 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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DeploymentOperations_ListAtManagementGroupScope (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
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 ,
}

⚐ 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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}

⚐ 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 ,
}
,
]
,
}
,
}
DeploymentOperations_GetAtSubscriptionScope (new)
Description :  Gets a deployments operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}
{
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 Microsoft Azure subscription ID. ,
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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DeploymentOperations_ListAtSubscriptionScope (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations
{
deploymentName:
{
Description: The name of the deployment. ,
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 Microsoft Azure subscription ID. ,
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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}

⚐ 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 ,
}
,
]
,
}
,
}
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 Microsoft Azure subscription ID. ,
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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 Microsoft Azure subscription ID. ,
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 ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
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 ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
}

⚐ 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 ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ListAtResourceGroup (removed)
Description :  Lists all the Deployment stacks within the specified Resource Group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Deployment stacks. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ListAtSubscription (removed)
Description :  Lists all the Deployment stacks within the specified Subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Deployment stacks. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ListAtManagementGroup (removed)
Description :  Lists all the Deployment stacks within the specified Management Group.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Deployment stacks. ,
Required: False ,
}
[
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_CreateOrUpdateAtResourceGroup (removed)
Description :  Creates or updates a Deployment stack at Resource Group scope.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_GetAtResourceGroup (removed)
Description :  Gets a Deployment stack with a given name at Resource Group scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_DeleteAtResourceGroup (removed)
Description :  Deletes a Deployment stack by name at Resource Group scope. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for unmanaged resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged resource groups. ,
Required: False ,
}
string ,
unmanageAction.ManagementGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged management groups. ,
Required: False ,
}
string ,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_CreateOrUpdateAtSubscription (removed)
Description :  Creates or updates a Deployment stack at Subscription scope.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_GetAtSubscription (removed)
Description :  Gets a Deployment stack with a given name at Subscription scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_DeleteAtSubscription (removed)
Description :  Deletes a Deployment stack by name at Subscription scope. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for unmanaged resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged resource groups. ,
Required: False ,
}
string ,
unmanageAction.ManagementGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged management groups. ,
Required: False ,
}
string ,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_CreateOrUpdateAtManagementGroup (removed)
Description :  Creates or updates a Deployment stack at Management Group scope.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_GetAtManagementGroup (removed)
Description :  Gets a Deployment stack with a given name at Management Group scope.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_DeleteAtManagementGroup (removed)
Description :  Deletes a Deployment stack by name at Management Group scope. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for unmanaged resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged resource groups. ,
Required: False ,
}
string ,
unmanageAction.ManagementGroups:
{
Description: Flag to indicate delete rather than detach for unmanaged management groups. ,
Required: False ,
}
string ,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ExportTemplateAtResourceGroup (removed)
Description :  Exports the template used to create the Deployment stack at Resource Group scope.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. Use this element 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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ExportTemplateAtSubscription (removed)
Description :  Exports the template used to create the Deployment stack at Subscription scope.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. Use this element 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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ExportTemplateAtManagementGroup (removed)
Description :  Exports the template used to create the Deployment stack at Management Group scope.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. Use this element 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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ValidateStackAtResourceGroup (removed)
Description :  Runs preflight validation on the Resource Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/validate
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack to validate. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (400)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ValidateStackAtSubscription (removed)
Description :  Runs preflight validation on the Subscription scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/validate
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack to validate. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (400)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}
DeploymentStacks_ValidateStackAtManagementGroup (removed)
Description :  Runs preflight validation on the Management Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/validate
{
managementGroupId:
{
Description: Management Group id. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
deploymentStack:
{
Description: Deployment stack to validate. ,
Required: True ,
}
{
location:
{
Description: The location of the Deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. ,
Required: False ,
}
string ,
tags:
{
Description: Deployment stack resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Deployment stack properties. ,
Required: False ,
}
{
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. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
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. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. 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 ,
}
,
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: True ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. ,
Required: False ,
}
string ,
}
,
bypassStackOutOfSyncError:
{
Description: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized. ,
Required: False ,
}
boolean ,
deploymentScope:
{
Description: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). ,
Required: False ,
}
string ,
description:
{
Description: Deployment stack description. Max length of 4096 characters. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: State of the deployment stack. ,
Enum:
{
creating: No description available. ,
validating: No description available. ,
waiting: No description available. ,
deploying: No description available. ,
canceling: No description available. ,
updatingDenyAssignments: No description available. ,
deletingResources: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
canceled: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
detachedResources:
{
Description: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
deletedResources:
{
Description: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
failedResources:
{
Description: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message. ,
Required: False ,
}
[
object ,
]
,
resources:
{
Description: An array of resources currently managed by the deployment stack. ,
Required: False ,
}
[
{
status:
{
Description: Current management state of the resource in the deployment stack. ,
Enum:
{
managed: This resource is managed by the deployment stack. ,
removeDenyFailed: Unable to remove the deny assignment on resource. ,
deleteFailed: Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. ,
}
,
Required: False ,
}
enum ,
denyStatus:
{
Description: denyAssignment settings applied to the resource. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
notSupported: Resource type does not support denyAssignments. ,
inapplicable: denyAssignments are not supported on resources outside the scope of the deployment stack. ,
denyWriteAndDelete: Authorized users can only read from a resource, but cannot modify or delete it. ,
removedBySystem: Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) ,
none: No denyAssignments have been applied. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
deploymentId:
{
Description: The resourceId of the deployment resource created by the deployment stack. ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs of the deployment resource created by the deployment stack. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the last successful Deployment stack update. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (400)

{
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: No description available. ,
detach: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The resourceId of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error detail. ,
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 ,
}
,
]
,
}
,
}