Microsoft.Resources (preview:2022-08-01)

2025/06/04 • 15 new, 15 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. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. 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. ,
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 the resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for the resource groups. ,
Required: False ,
}
string ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. 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. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for the resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for the resource groups. ,
Required: False ,
}
string ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. 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. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for the resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for the resource groups. ,
Required: False ,
}
string ,
unmanageAction.ManagementGroups:
{
Description: Flag to indicate delete rather than detach for the management groups. ,
Required: False ,
}
string ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
managementGroupId:
{
Description: Management Group. ,
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 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 ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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_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. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. 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. ,
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 the resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for the resource groups. ,
Required: False ,
}
string ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. 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. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for the resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for the resource groups. ,
Required: False ,
}
string ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the 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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
{
managementGroupId:
{
Description: Management Group. ,
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 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 ,
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. It can be a JObject or a well formed JSON string. ,
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 not managed immediately after the stack is updated. ,
Required: True ,
}
{
resources:
{
Description: Specifies the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 the action that should be taken on the resource when the deployment stack is deleted. 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 ,
}
,
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. ,
Required: False ,
}
string ,
denySettings:
{
Description: Defines how resources deployed by the stack are locked. ,
Required: True ,
}
{
mode:
{
Description: denySettings Mode. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can only 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 scopes. ,
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. ,
Locking: 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 ,
detachedResources:
{
Description: An array of resources that were detached during the most recent update. ,
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 update. ,
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. ,
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. ,
None: No denyAssignments have been applied. ,
}
,
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 underlying deployment. ,
Required: False ,
}
object ,
duration:
{
Description: The duration of the deployment stack update. ,
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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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. 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. ,
Required: True ,
}
string ,
deploymentStackName:
{
Description: Name of the deployment stack. ,
Required: True ,
}
string ,
unmanageAction.Resources:
{
Description: Flag to indicate delete rather than detach for the resources. ,
Required: False ,
}
string ,
unmanageAction.ResourceGroups:
{
Description: Flag to indicate delete rather than detach for the resource groups. ,
Required: False ,
}
string ,
unmanageAction.ManagementGroups:
{
Description: Flag to indicate delete rather than detach for the management groups. ,
Required: False ,
}
string ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 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 ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate
{
managementGroupId:
{
Description: Management Group. ,
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 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 ,
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: 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 ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
,
}