| Description | : Lists Deployment stacks at the specified scope. |
| Reference | : Link ¶ |
⚶ Changes
{
"#id": "DeploymentStacks_ListAtManagementGroup",
"Description": {
"new": "Lists Deployment stacks at the specified scope.",
"old": "Lists all the Deployment Stacks within the specified management group."
},
"$parameters": [
{
"#name": "managementGroupId",
"Description": {
"new": "The name of the management group. The name is case insensitive.",
"old": "Management Group."
}
}
],
"$responses": {
"200": {
"Description": {
"new": "The response of a DeploymentStack list operation.",
"old": "List of deployment stacks."
},
"$properties": [
{
"#name": "value",
"Description": {
"new": "The DeploymentStack items on this page",
"old": "An array of deployment stacks."
},
"Required": {
"new": true,
"old": false
},
"$items": {
"$properties": [
{
"properties": [
{
"templateLink": [
{
"#name": "id",
"Description": {
"new": "The resourceId of a Template Spec. Use either the id or uri property, but not both.",
"old": "The resource id of a Template Spec. Use either the id or uri property, but not both."
}
},
{
"#name": "relativePath",
"Description": {
"new": "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.",
"old": "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"
}
}
]
},
{
"#name": "parameters",
"Description": {
"new": "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.",
"old": "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."
}
},
{
"#name": "actionOnUnmanage",
"Description": {
"new": "Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.",
"old": "Defines the behavior of resources that are not managed immediately after the stack is updated."
},
"$properties": [
{
"#name": "resources",
"Description": {
"new": "Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state.",
"old": "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": {
"new": [
[
"delete",
"Delete the specified resources from Azure"
],
[
"detach",
"Keep the specified resources in Azure"
]
],
"old": [
[
"delete",
""
],
[
"detach",
""
]
]
}
},
{
"#name": "resourceGroups",
"Description": {
"new": "Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state.",
"old": "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": {
"new": [
[
"delete",
"Delete the specified resources from Azure"
],
[
"detach",
"Keep the specified resources in Azure"
]
],
"old": [
[
"delete",
""
],
[
"detach",
""
]
]
}
},
{
"#name": "managementGroups",
"Description": {
"new": "Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state.",
"old": "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": {
"new": [
[
"delete",
"Delete the specified resources from Azure"
],
[
"detach",
"Keep the specified resources in Azure"
]
],
"old": [
[
"delete",
""
],
[
"detach",
""
]
]
}
}
]
},
{
"#name": "description",
"Description": {
"new": "Deployment stack description. Max length of 4096 characters.",
"old": "Deployment stack description."
}
},
{
"denySettings": [
{
"#name": "mode",
"Description": {
"new": "denySettings Mode that defines denied actions.",
"old": "denySettings Mode."
},
"Enum": {
"new": [
[
"denyDelete",
"Authorized users are able to read and modify the resources, but cannot delete."
],
[
"denyWriteAndDelete",
"Authorized users can read from a resource, but cannot modify or delete it."
],
[
"none",
"No denyAssignments have been applied."
]
],
"old": [
[
"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."
]
]
}
},
{
"#name": "applyToChildScopes",
"Description": {
"new": "DenySettings will be applied to child resource scopes of every managed resource with a deny assignment.",
"old": "DenySettings will be applied to child scopes."
}
}
]
},
{
"#name": "provisioningState",
"Enum": {
"new": [
[
"creating",
"The deployment stack is currently being created"
],
[
"validating",
"The deployment stack is currently being validated"
],
[
"waiting",
"The deployment stack is currently waiting"
],
[
"deploying",
"The deployment stack is currently deploying"
],
[
"canceling",
"The deployment stack is being cancelled"
],
[
"updatingDenyAssignments",
"The deployment stack is updating deny assignments"
],
[
"deletingResources",
"The deployment stack is deleting resources"
],
[
"succeeded",
"The deployment stack completed successfully"
],
[
"failed",
"The deployment stack has failed"
],
[
"canceled",
"The deployment stack has been cancelled"
],
[
"deleting",
"The deployment stack is being deleted"
]
],
"old": [
[
"Creating",
""
],
[
"Validating",
""
],
[
"Waiting",
""
],
[
"Deploying",
""
],
[
"Canceling",
""
],
[
"Locking",
""
],
[
"DeletingResources",
""
],
[
"Succeeded",
""
],
[
"Failed",
""
],
[
"Canceled",
""
],
[
"Deleting",
""
]
]
}
},
{
"#name": "detachedResources",
"Description": {
"new": "An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.",
"old": "An array of resources that were detached during the most recent update."
},
"$items": {
"Description": {
"new": "The resourceId model.",
"old": "The resource Id model."
},
"$properties": [
{
"#name": "id",
"Description": {
"new": "The ARM Resource ID of a resource managed by the deployment stack.",
"old": "The resourceId of a resource managed by the deployment stack."
}
}
]
}
},
{
"#name": "deletedResources",
"Description": {
"new": "An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.",
"old": "An array of resources that were deleted during the most recent update."
},
"$items": {
"Description": {
"new": "The resourceId model.",
"old": "The resource Id model."
},
"$properties": [
{
"#name": "id",
"Description": {
"new": "The ARM Resource ID of a resource managed by the deployment stack.",
"old": "The resourceId of a resource managed by the deployment stack."
}
}
]
}
},
{
"#name": "failedResources",
"Description": {
"new": "An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.",
"old": "An array of resources that failed to reach goal state during the most recent update."
},
"$items": {
"Description": {
"new": "The resourceId extended model. This is used to document failed resources with a resourceId and a corresponding error.",
"old": "The resource Id extended model."
}
}
},
{
"resources": {
"$properties": [
{
"#name": "denyStatus",
"Enum": {
"new": [
[
"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."
]
],
"old": [
[
"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."
]
]
}
},
{
"#name": "status",
"Enum": {
"new": [
[
"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 management state."
]
],
"old": [
[
"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."
]
]
}
}
]
}
},
{
"#name": "outputs",
"Description": {
"new": "The outputs of the deployment resource created by the deployment stack.",
"old": "The outputs of the underlying deployment."
}
},
{
"#name": "duration",
"Description": {
"new": "The duration of the last successful Deployment stack update.",
"old": "The duration of the deployment stack update."
}
}
]
},
{
"#name": "location",
"Description": {
"new": "The geo-location where the resource lives. Required for subscription and management group scoped stacks. The location is inherited from the resource group for resource group scoped stacks.",
"old": "The location of the deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations."
}
},
{
"#name": "tags",
"Description": {
"new": "Resource tags.",
"old": "Deployment stack resource tags."
}
}
]
}
},
{
"#name": "nextLink",
"Description": {
"new": "The link to the next page of items",
"old": "The URL to use for getting the next set of results."
}
}
]
},
"default": {
"Description": {
"new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
"old": "Deployment Stacks error response."
},
"$properties": [
{
"#name": "error",
"Description": {
"new": "The error object.",
"old": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)."
},
"$properties": {
"@added_ec58543c6a7649509cd68acd2b3637b4": {
"#name": "code",
"Description": "The error code.",
"Required": false,
"Type": "string"
},
"@added_718fb9896f964e51be2dd24eedde878b": {
"#name": "message",
"Description": "The error message.",
"Required": false,
"Type": "string"
},
"@added_5193a88d867a4830b827d659de8aa63b": {
"#name": "target",
"Description": "The error target.",
"Required": false,
"Type": "string"
},
"@added_6dbe710e4aee467ba942c32656903c5f": {
"#name": "details",
"Description": "The error details.",
"Required": false,
"Type": "array",
"$items": {
"Description": "The error detail.",
"Type": "object",
"$properties": [
{
"#name": "code",
"Description": "The error code.",
"Required": false,
"Type": "string"
},
{
"#name": "message",
"Description": "The error message.",
"Required": false,
"Type": "string"
},
{
"#name": "target",
"Description": "The error target.",
"Required": false,
"Type": "string"
},
{
"#name": "details",
"Description": "The error details.",
"Required": false,
"Type": "array",
"$items": {
"Type": "string"
}
},
{
"#name": "additionalInfo",
"Description": "The error additional info.",
"Required": false,
"Type": "array",
"$items": {
"Description": "The resource management error additional info.",
"Type": "object",
"$properties": [
{
"#name": "type",
"Description": "The additional info type.",
"Required": false,
"Type": "string"
},
{
"#name": "info",
"Description": "The additional info.",
"Required": false,
"Type": "object"
}
]
}
}
]
}
},
"@added_bc65d0214e5e4dd4b1e4d1b6f5a1d8b3": {
"#name": "additionalInfo",
"Description": "The error additional info.",
"Required": false,
"Type": "array",
"$items": {
"Description": "The resource management error additional info.",
"Type": "object",
"$properties": [
{
"#name": "type",
"Description": "The additional info type.",
"Required": false,
"Type": "string"
},
{
"#name": "info",
"Description": "The additional info.",
"Required": false,
"Type": "object"
}
]
}
},
"@removed_f37fa65d3d4546bbbacb6b8e27cbbfe3": {
"#name": "error",
"Description": "The error object.",
"Required": false,
"Type": "object",
"$properties": [
{
"#name": "code",
"Description": "The error code.",
"Required": false,
"Type": "string"
},
{
"#name": "message",
"Description": "The error message.",
"Required": false,
"Type": "string"
},
{
"#name": "target",
"Description": "The error target.",
"Required": false,
"Type": "string"
},
{
"#name": "details",
"Description": "The error details.",
"Required": false,
"Type": "array",
"$items": {
"Type": "string"
}
},
{
"#name": "additionalInfo",
"Description": "The error additional info.",
"Required": false,
"Type": "array",
"$items": {
"Description": "The resource management error additional info.",
"Type": "object",
"$properties": [
{
"#name": "type",
"Description": "The additional info type.",
"Required": false,
"Type": "string"
},
{
"#name": "info",
"Description": "The additional info.",
"Required": false,
"Type": "object"
}
]
}
}
]
}
}
}
]
}
}
}
⚼ Request
GET:
/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks
{
api-version:
string
,
managementGroupId:
string
,
}
⚐ Response (200)
{
value:
[
]
,
{
,
properties:
{
,
template:
object
,
templateLink:
{
,
uri:
string
,
id:
string
,
relativePath:
string
,
queryString:
string
,
contentVersion:
string
,
}
parameters:
object
,
parametersLink:
{
,
uri:
string
,
contentVersion:
string
,
}
actionOnUnmanage:
{
,
resources:
enum
,
resourceGroups:
enum
,
managementGroups:
enum
,
}
debugSetting:
{
,
detailLevel:
string
,
}
deploymentScope:
string
,
description:
string
,
denySettings:
{
,
mode:
enum
,
excludedPrincipals:
[
,
string
,
]
excludedActions:
[
,
string
,
]
applyToChildScopes:
boolean
,
}
provisioningState:
enum
,
detachedResources:
[
]
,
{
,
id:
string
,
}
deletedResources:
[
]
,
{
,
id:
string
,
}
failedResources:
[
]
,
{
,
id:
string
,
error:
}
{
,
code:
string
,
message:
string
,
target:
string
,
details:
[
]
,
{
,
code:
string
,
message:
string
,
target:
string
,
details:
[
,
string
,
]
additionalInfo:
}
[
]
,
{
,
type:
string
,
info:
object
,
}
additionalInfo:
}
[
]
,
{
,
type:
string
,
info:
object
,
}
resources:
[
]
,
{
,
denyStatus:
enum
,
status:
enum
,
}
deploymentId:
string
,
outputs:
object
,
duration:
string
,
}
location:
string
,
tags:
object
,
}
nextLink:
string
,
}
⚐ Response (default)
{
error:
}
{
,
code:
string
,
message:
string
,
target:
string
,
details:
[
]
,
{
,
code:
string
,
message:
string
,
target:
string
,
details:
[
,
string
,
]
additionalInfo:
}
[
]
,
{
,
type:
string
,
info:
object
,
}
additionalInfo:
}
[
]
,
{
,
type:
string
,
info:
object
,
}