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

2025/08/20 • 18 updated methods

DeploymentStacks_ListAtManagementGroup (updated)
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 id."
      }
    }
  ],
  "$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": [
                  {
                    "actionOnUnmanage": [
                      {
                        "#name": "resources",
                        "Enum": {
                          "new": [
                            [
                              "delete",
                              "Delete the specified resources from Azure"
                            ],
                            [
                              "detach",
                              "Keep the specified resources in Azure"
                            ]
                          ],
                          "old": [
                            [
                              "delete",
                              ""
                            ],
                            [
                              "detach",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "resourceGroups",
                        "Enum": {
                          "new": [
                            [
                              "delete",
                              "Delete the specified resources from Azure"
                            ],
                            [
                              "detach",
                              "Keep the specified resources in Azure"
                            ]
                          ],
                          "old": [
                            [
                              "delete",
                              ""
                            ],
                            [
                              "detach",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "managementGroups",
                        "Enum": {
                          "new": [
                            [
                              "delete",
                              "Delete the specified resources from Azure"
                            ],
                            [
                              "detach",
                              "Keep the specified resources in Azure"
                            ]
                          ],
                          "old": [
                            [
                              "delete",
                              ""
                            ],
                            [
                              "detach",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#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",
                          ""
                        ],
                        [
                          "updatingDenyAssignments",
                          ""
                        ],
                        [
                          "deletingResources",
                          ""
                        ],
                        [
                          "succeeded",
                          ""
                        ],
                        [
                          "failed",
                          ""
                        ],
                        [
                          "canceled",
                          ""
                        ],
                        [
                          "deleting",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "detachedResources": {
                      "$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."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "deletedResources": {
                      "$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": "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: The name of the management group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_GetAtManagementGroup (updated)
Description :  Gets the Deployment stack with the given name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_GetAtManagementGroup",
  "Description": {
    "new": "Gets the Deployment stack with the given name.",
    "old": "Gets a Deployment stack with a given name at Management Group scope."
  },
  "$parameters": [
    {
      "#name": "managementGroupId",
      "Description": {
        "new": "The name of the management group. The name is case insensitive.",
        "old": "Management Group id."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "actionOnUnmanage": [
                {
                  "#name": "resources",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "resourceGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#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",
                    ""
                  ],
                  [
                    "updatingDenyAssignments",
                    ""
                  ],
                  [
                    "deletingResources",
                    ""
                  ],
                  [
                    "succeeded",
                    ""
                  ],
                  [
                    "failed",
                    ""
                  ],
                  [
                    "canceled",
                    ""
                  ],
                  [
                    "deleting",
                    ""
                  ]
                ]
              }
            },
            {
              "detachedResources": {
                "$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."
                    }
                  }
                ]
              }
            },
            {
              "deletedResources": {
                "$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": "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."
          }
        }
      ]
    },
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_CreateOrUpdateAtManagementGroup (updated)
Description :  Creates or updates a Deployment stack at the specified scope.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_CreateOrUpdateAtManagementGroup",
  "Description": {
    "new": "Creates or updates a Deployment stack at the specified scope.",
    "old": "Creates or updates a Deployment stack at Management Group scope."
  },
  "$parameters": [
    {
      "#name": "managementGroupId",
      "Description": {
        "new": "The name of the management group. The name is case insensitive.",
        "old": "Management Group id."
      }
    },
    {
      "#name": "deploymentStack",
      "Description": {
        "new": "Resource create parameters.",
        "old": "Deployment stack supplied to the operation."
      },
      "$schema": {
        "$properties": [
          {
            "properties": [
              {
                "actionOnUnmanage": [
                  {
                    "#name": "resources",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "resourceGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "managementGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#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",
                      ""
                    ],
                    [
                      "updatingDenyAssignments",
                      ""
                    ],
                    [
                      "deletingResources",
                      ""
                    ],
                    [
                      "succeeded",
                      ""
                    ],
                    [
                      "failed",
                      ""
                    ],
                    [
                      "canceled",
                      ""
                    ],
                    [
                      "deleting",
                      ""
                    ]
                  ]
                }
              },
              {
                "detachedResources": {
                  "$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."
                      }
                    }
                  ]
                }
              },
              {
                "deletedResources": {
                  "$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": "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."
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "actionOnUnmanage": [
                {
                  "#name": "resources",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "resourceGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#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",
                    ""
                  ],
                  [
                    "updatingDenyAssignments",
                    ""
                  ],
                  [
                    "deletingResources",
                    ""
                  ],
                  [
                    "succeeded",
                    ""
                  ],
                  [
                    "failed",
                    ""
                  ],
                  [
                    "canceled",
                    ""
                  ],
                  [
                    "deleting",
                    ""
                  ]
                ]
              }
            },
            {
              "detachedResources": {
                "$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."
                    }
                  }
                ]
              }
            },
            {
              "deletedResources": {
                "$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": "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."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "properties": [
            {
              "actionOnUnmanage": [
                {
                  "#name": "resources",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "resourceGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#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",
                    ""
                  ],
                  [
                    "updatingDenyAssignments",
                    ""
                  ],
                  [
                    "deletingResources",
                    ""
                  ],
                  [
                    "succeeded",
                    ""
                  ],
                  [
                    "failed",
                    ""
                  ],
                  [
                    "canceled",
                    ""
                  ],
                  [
                    "deleting",
                    ""
                  ]
                ]
              }
            },
            {
              "detachedResources": {
                "$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."
                    }
                  }
                ]
              }
            },
            {
              "deletedResources": {
                "$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": "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."
          }
        }
      ]
    },
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_DeleteAtManagementGroup (updated)
Description :  Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_DeleteAtManagementGroup",
  "Description": {
    "new": "Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.",
    "old": "Deletes a Deployment stack by name at Management Group scope. When operation completes, status code 200 returned without content."
  },
  "$parameters": [
    {
      "#name": "managementGroupId",
      "Description": {
        "new": "The name of the management group. The name is case insensitive.",
        "old": "Management Group id."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_26c8cdb418544c6b8dcedfcdc966029d": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_ExportTemplateAtManagementGroup (updated)
Description :  Exports the template used to create the Deployment stack at the specified scope.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_ExportTemplateAtManagementGroup",
  "Description": {
    "new": "Exports the template used to create the Deployment stack at the specified scope.",
    "old": "Exports the template used to create the Deployment stack at Management Group scope."
  },
  "$parameters": [
    {
      "#name": "managementGroupId",
      "Description": {
        "new": "The name of the management group. The name is case insensitive.",
        "old": "Management Group id."
      }
    }
  ],
  "$responses": {
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
template:
{
Description: The template content. Use this element to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error 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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_ValidateStackAtManagementGroup (updated)
Description :  Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_ValidateStackAtManagementGroup",
  "Description": {
    "new": "Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.",
    "old": "Runs preflight validation on the Management Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager."
  },
  "$parameters": [
    {
      "#name": "managementGroupId",
      "Description": {
        "new": "The name of the management group. The name is case insensitive.",
        "old": "Management Group id."
      }
    },
    {
      "#name": "deploymentStack",
      "Description": {
        "new": "The content of the action request",
        "old": "Deployment stack to validate."
      },
      "$schema": {
        "$properties": [
          {
            "properties": [
              {
                "actionOnUnmanage": [
                  {
                    "#name": "resources",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "resourceGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "managementGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#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",
                      ""
                    ],
                    [
                      "updatingDenyAssignments",
                      ""
                    ],
                    [
                      "deletingResources",
                      ""
                    ],
                    [
                      "succeeded",
                      ""
                    ],
                    [
                      "failed",
                      ""
                    ],
                    [
                      "canceled",
                      ""
                    ],
                    [
                      "deleting",
                      ""
                    ]
                  ]
                }
              },
              {
                "detachedResources": {
                  "$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."
                      }
                    }
                  ]
                }
              },
              {
                "deletedResources": {
                  "$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": "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."
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_d04335b8bdb54f519a6be5f9b6f5523b": {
          "#name": "id",
          "Description": "String Id used to locate any resource on Azure.",
          "Required": false,
          "Type": "string"
        },
        "@added_749d0f0a7630481893ff58cc7877a0f6": {
          "#name": "name",
          "Description": "Name of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_a1dd1c842e2743ca92100f1810e28d3b": {
          "#name": "type",
          "Description": "Type of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_af27ad87abaa4613a256d40ec332e841": {
          "#name": "systemData",
          "Description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_b67f794bbaa04c76aa33d45697688418": {
          "#name": "error",
          "Description": "The error detail.",
          "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": {
                "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"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#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"
                  }
                ]
              }
            }
          ]
        },
        "properties": [
          {
            "actionOnUnmanage": [
              {
                "#name": "resources",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "resourceGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "managementGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "validatedResources": {
              "$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."
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "202": [
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Number of seconds to wait before polling for status."
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ],
    "400": {
      "$properties": {
        "@added_c3fc7e1cb67140208a23c605bf398ebe": {
          "#name": "id",
          "Description": "String Id used to locate any resource on Azure.",
          "Required": false,
          "Type": "string"
        },
        "@added_49d2a4b2905047f8b241e8a275cffb23": {
          "#name": "name",
          "Description": "Name of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_84e1037903d84779acaf8ebcb74561fa": {
          "#name": "type",
          "Description": "Type of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_d5ae15b619d14591afb35ef1d6044952": {
          "#name": "systemData",
          "Description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_e160c6a575f64b43b81949864ae14782": {
          "#name": "error",
          "Description": "The error detail.",
          "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": {
                "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"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#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"
                  }
                ]
              }
            }
          ]
        },
        "properties": [
          {
            "actionOnUnmanage": [
              {
                "#name": "resources",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "resourceGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "managementGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "validatedResources": {
              "$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."
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: String Id used to locate any resource on Azure. ,
Required: False ,
}
string ,
name:
{
Description: Name of this resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of this resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource ID of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (400)

{
id:
{
Description: String Id used to locate any resource on Azure. ,
Required: False ,
}
string ,
name:
{
Description: Name of this resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of this resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource ID of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_ListAtSubscription (updated)
Description :  Lists Deployment stacks at the specified scope.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_ListAtSubscription",
  "Description": {
    "new": "Lists Deployment stacks at the specified scope.",
    "old": "Lists all the Deployment stacks within the specified Subscription."
  },
  "$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": [
                  {
                    "actionOnUnmanage": [
                      {
                        "#name": "resources",
                        "Enum": {
                          "new": [
                            [
                              "delete",
                              "Delete the specified resources from Azure"
                            ],
                            [
                              "detach",
                              "Keep the specified resources in Azure"
                            ]
                          ],
                          "old": [
                            [
                              "delete",
                              ""
                            ],
                            [
                              "detach",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "resourceGroups",
                        "Enum": {
                          "new": [
                            [
                              "delete",
                              "Delete the specified resources from Azure"
                            ],
                            [
                              "detach",
                              "Keep the specified resources in Azure"
                            ]
                          ],
                          "old": [
                            [
                              "delete",
                              ""
                            ],
                            [
                              "detach",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "managementGroups",
                        "Enum": {
                          "new": [
                            [
                              "delete",
                              "Delete the specified resources from Azure"
                            ],
                            [
                              "detach",
                              "Keep the specified resources in Azure"
                            ]
                          ],
                          "old": [
                            [
                              "delete",
                              ""
                            ],
                            [
                              "detach",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#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",
                          ""
                        ],
                        [
                          "updatingDenyAssignments",
                          ""
                        ],
                        [
                          "deletingResources",
                          ""
                        ],
                        [
                          "succeeded",
                          ""
                        ],
                        [
                          "failed",
                          ""
                        ],
                        [
                          "canceled",
                          ""
                        ],
                        [
                          "deleting",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "detachedResources": {
                      "$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."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "deletedResources": {
                      "$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": "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_GetAtSubscription (updated)
Description :  Gets the Deployment stack with the given name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_GetAtSubscription",
  "Description": {
    "new": "Gets the Deployment stack with the given name.",
    "old": "Gets a Deployment stack with a given name at Subscription scope."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "actionOnUnmanage": [
                {
                  "#name": "resources",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "resourceGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#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",
                    ""
                  ],
                  [
                    "updatingDenyAssignments",
                    ""
                  ],
                  [
                    "deletingResources",
                    ""
                  ],
                  [
                    "succeeded",
                    ""
                  ],
                  [
                    "failed",
                    ""
                  ],
                  [
                    "canceled",
                    ""
                  ],
                  [
                    "deleting",
                    ""
                  ]
                ]
              }
            },
            {
              "detachedResources": {
                "$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."
                    }
                  }
                ]
              }
            },
            {
              "deletedResources": {
                "$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": "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."
          }
        }
      ]
    },
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_CreateOrUpdateAtSubscription (updated)
Description :  Creates or updates a Deployment stack at the specified scope.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_CreateOrUpdateAtSubscription",
  "Description": {
    "new": "Creates or updates a Deployment stack at the specified scope.",
    "old": "Creates or updates a Deployment stack at Subscription scope."
  },
  "$parameters": [
    {
      "#name": "deploymentStack",
      "Description": {
        "new": "Resource create parameters.",
        "old": "Deployment stack supplied to the operation."
      },
      "$schema": {
        "$properties": [
          {
            "properties": [
              {
                "actionOnUnmanage": [
                  {
                    "#name": "resources",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "resourceGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "managementGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#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",
                      ""
                    ],
                    [
                      "updatingDenyAssignments",
                      ""
                    ],
                    [
                      "deletingResources",
                      ""
                    ],
                    [
                      "succeeded",
                      ""
                    ],
                    [
                      "failed",
                      ""
                    ],
                    [
                      "canceled",
                      ""
                    ],
                    [
                      "deleting",
                      ""
                    ]
                  ]
                }
              },
              {
                "detachedResources": {
                  "$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."
                      }
                    }
                  ]
                }
              },
              {
                "deletedResources": {
                  "$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": "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."
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "actionOnUnmanage": [
                {
                  "#name": "resources",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "resourceGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#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",
                    ""
                  ],
                  [
                    "updatingDenyAssignments",
                    ""
                  ],
                  [
                    "deletingResources",
                    ""
                  ],
                  [
                    "succeeded",
                    ""
                  ],
                  [
                    "failed",
                    ""
                  ],
                  [
                    "canceled",
                    ""
                  ],
                  [
                    "deleting",
                    ""
                  ]
                ]
              }
            },
            {
              "detachedResources": {
                "$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."
                    }
                  }
                ]
              }
            },
            {
              "deletedResources": {
                "$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": "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."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "properties": [
            {
              "actionOnUnmanage": [
                {
                  "#name": "resources",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "resourceGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#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",
                    ""
                  ],
                  [
                    "updatingDenyAssignments",
                    ""
                  ],
                  [
                    "deletingResources",
                    ""
                  ],
                  [
                    "succeeded",
                    ""
                  ],
                  [
                    "failed",
                    ""
                  ],
                  [
                    "canceled",
                    ""
                  ],
                  [
                    "deleting",
                    ""
                  ]
                ]
              }
            },
            {
              "detachedResources": {
                "$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."
                    }
                  }
                ]
              }
            },
            {
              "deletedResources": {
                "$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": "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."
          }
        }
      ]
    },
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_DeleteAtSubscription (updated)
Description :  Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_DeleteAtSubscription",
  "Description": {
    "new": "Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.",
    "old": "Deletes a Deployment stack by name at Subscription scope. When operation completes, status code 200 returned without content."
  },
  "$responses": {
    "202": [
      {
        "@added_2661afc026e148768db6df54a675357c": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_ExportTemplateAtSubscription (updated)
Description :  Exports the template used to create the Deployment stack at the specified scope.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_ExportTemplateAtSubscription",
  "Description": {
    "new": "Exports the template used to create the Deployment stack at the specified scope.",
    "old": "Exports the template used to create the Deployment stack at Subscription scope."
  },
  "$responses": {
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
template:
{
Description: The template content. Use this element to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error 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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_ValidateStackAtSubscription (updated)
Description :  Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_ValidateStackAtSubscription",
  "Description": {
    "new": "Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.",
    "old": "Runs preflight validation on the Subscription scoped Deployment stack template to verify its acceptance to Azure Resource Manager."
  },
  "$parameters": [
    {
      "#name": "deploymentStack",
      "Description": {
        "new": "The content of the action request",
        "old": "Deployment stack to validate."
      },
      "$schema": {
        "$properties": [
          {
            "properties": [
              {
                "actionOnUnmanage": [
                  {
                    "#name": "resources",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "resourceGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "managementGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#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",
                      ""
                    ],
                    [
                      "updatingDenyAssignments",
                      ""
                    ],
                    [
                      "deletingResources",
                      ""
                    ],
                    [
                      "succeeded",
                      ""
                    ],
                    [
                      "failed",
                      ""
                    ],
                    [
                      "canceled",
                      ""
                    ],
                    [
                      "deleting",
                      ""
                    ]
                  ]
                }
              },
              {
                "detachedResources": {
                  "$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."
                      }
                    }
                  ]
                }
              },
              {
                "deletedResources": {
                  "$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": "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."
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_480045742d27448e8ffd494898f26806": {
          "#name": "id",
          "Description": "String Id used to locate any resource on Azure.",
          "Required": false,
          "Type": "string"
        },
        "@added_2f175a2fc1ac4af0a270e6413f573feb": {
          "#name": "name",
          "Description": "Name of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_463e2fea2b994af4bc97e181deadbc75": {
          "#name": "type",
          "Description": "Type of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_8de17657e61c4ff7a307398af5d344b6": {
          "#name": "systemData",
          "Description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_e9976cc31cca4dca952ee176d0754592": {
          "#name": "error",
          "Description": "The error detail.",
          "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": {
                "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"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#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"
                  }
                ]
              }
            }
          ]
        },
        "properties": [
          {
            "actionOnUnmanage": [
              {
                "#name": "resources",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "resourceGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "managementGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "validatedResources": {
              "$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."
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "202": [
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Number of seconds to wait before polling for status."
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ],
    "400": {
      "$properties": {
        "@added_b61c1799a402477a908d60db1b401a4f": {
          "#name": "id",
          "Description": "String Id used to locate any resource on Azure.",
          "Required": false,
          "Type": "string"
        },
        "@added_66c83dd1aa6247988ae0895d9b4b36a1": {
          "#name": "name",
          "Description": "Name of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_e50d0e84f9ec40af903c0c355d2e1df2": {
          "#name": "type",
          "Description": "Type of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_20dbbeaeea314de2801929c6528baf98": {
          "#name": "systemData",
          "Description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_cacb85d3b26e4332ac26dcab7a812766": {
          "#name": "error",
          "Description": "The error detail.",
          "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": {
                "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"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#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"
                  }
                ]
              }
            }
          ]
        },
        "properties": [
          {
            "actionOnUnmanage": [
              {
                "#name": "resources",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "resourceGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "managementGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "validatedResources": {
              "$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."
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: String Id used to locate any resource on Azure. ,
Required: False ,
}
string ,
name:
{
Description: Name of this resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of this resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource ID of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (400)

{
id:
{
Description: String Id used to locate any resource on Azure. ,
Required: False ,
}
string ,
name:
{
Description: Name of this resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of this resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource ID of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_ListAtResourceGroup (updated)
Description :  Lists Deployment stacks at the specified scope.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_ListAtResourceGroup",
  "Description": {
    "new": "Lists Deployment stacks at the specified scope.",
    "old": "Lists all the Deployment stacks within the specified Resource 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": [
                  {
                    "actionOnUnmanage": [
                      {
                        "#name": "resources",
                        "Enum": {
                          "new": [
                            [
                              "delete",
                              "Delete the specified resources from Azure"
                            ],
                            [
                              "detach",
                              "Keep the specified resources in Azure"
                            ]
                          ],
                          "old": [
                            [
                              "delete",
                              ""
                            ],
                            [
                              "detach",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "resourceGroups",
                        "Enum": {
                          "new": [
                            [
                              "delete",
                              "Delete the specified resources from Azure"
                            ],
                            [
                              "detach",
                              "Keep the specified resources in Azure"
                            ]
                          ],
                          "old": [
                            [
                              "delete",
                              ""
                            ],
                            [
                              "detach",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "managementGroups",
                        "Enum": {
                          "new": [
                            [
                              "delete",
                              "Delete the specified resources from Azure"
                            ],
                            [
                              "detach",
                              "Keep the specified resources in Azure"
                            ]
                          ],
                          "old": [
                            [
                              "delete",
                              ""
                            ],
                            [
                              "detach",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#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",
                          ""
                        ],
                        [
                          "updatingDenyAssignments",
                          ""
                        ],
                        [
                          "deletingResources",
                          ""
                        ],
                        [
                          "succeeded",
                          ""
                        ],
                        [
                          "failed",
                          ""
                        ],
                        [
                          "canceled",
                          ""
                        ],
                        [
                          "deleting",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "detachedResources": {
                      "$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."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "deletedResources": {
                      "$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": "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_GetAtResourceGroup (updated)
Description :  Gets the Deployment stack with the given name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_GetAtResourceGroup",
  "Description": {
    "new": "Gets the Deployment stack with the given name.",
    "old": "Gets a Deployment stack with a given name at Resource Group scope."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "actionOnUnmanage": [
                {
                  "#name": "resources",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "resourceGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#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",
                    ""
                  ],
                  [
                    "updatingDenyAssignments",
                    ""
                  ],
                  [
                    "deletingResources",
                    ""
                  ],
                  [
                    "succeeded",
                    ""
                  ],
                  [
                    "failed",
                    ""
                  ],
                  [
                    "canceled",
                    ""
                  ],
                  [
                    "deleting",
                    ""
                  ]
                ]
              }
            },
            {
              "detachedResources": {
                "$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."
                    }
                  }
                ]
              }
            },
            {
              "deletedResources": {
                "$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": "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."
          }
        }
      ]
    },
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_CreateOrUpdateAtResourceGroup (updated)
Description :  Creates or updates a Deployment stack at the specified scope.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_CreateOrUpdateAtResourceGroup",
  "Description": {
    "new": "Creates or updates a Deployment stack at the specified scope.",
    "old": "Creates or updates a Deployment stack at Resource Group scope."
  },
  "$parameters": [
    {
      "#name": "deploymentStack",
      "Description": {
        "new": "Resource create parameters.",
        "old": "Deployment stack supplied to the operation."
      },
      "$schema": {
        "$properties": [
          {
            "properties": [
              {
                "actionOnUnmanage": [
                  {
                    "#name": "resources",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "resourceGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "managementGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#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",
                      ""
                    ],
                    [
                      "updatingDenyAssignments",
                      ""
                    ],
                    [
                      "deletingResources",
                      ""
                    ],
                    [
                      "succeeded",
                      ""
                    ],
                    [
                      "failed",
                      ""
                    ],
                    [
                      "canceled",
                      ""
                    ],
                    [
                      "deleting",
                      ""
                    ]
                  ]
                }
              },
              {
                "detachedResources": {
                  "$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."
                      }
                    }
                  ]
                }
              },
              {
                "deletedResources": {
                  "$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": "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."
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "actionOnUnmanage": [
                {
                  "#name": "resources",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "resourceGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#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",
                    ""
                  ],
                  [
                    "updatingDenyAssignments",
                    ""
                  ],
                  [
                    "deletingResources",
                    ""
                  ],
                  [
                    "succeeded",
                    ""
                  ],
                  [
                    "failed",
                    ""
                  ],
                  [
                    "canceled",
                    ""
                  ],
                  [
                    "deleting",
                    ""
                  ]
                ]
              }
            },
            {
              "detachedResources": {
                "$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."
                    }
                  }
                ]
              }
            },
            {
              "deletedResources": {
                "$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": "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."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "properties": [
            {
              "actionOnUnmanage": [
                {
                  "#name": "resources",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "resourceGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementGroups",
                  "Enum": {
                    "new": [
                      [
                        "delete",
                        "Delete the specified resources from Azure"
                      ],
                      [
                        "detach",
                        "Keep the specified resources in Azure"
                      ]
                    ],
                    "old": [
                      [
                        "delete",
                        ""
                      ],
                      [
                        "detach",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#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",
                    ""
                  ],
                  [
                    "updatingDenyAssignments",
                    ""
                  ],
                  [
                    "deletingResources",
                    ""
                  ],
                  [
                    "succeeded",
                    ""
                  ],
                  [
                    "failed",
                    ""
                  ],
                  [
                    "canceled",
                    ""
                  ],
                  [
                    "deleting",
                    ""
                  ]
                ]
              }
            },
            {
              "detachedResources": {
                "$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."
                    }
                  }
                ]
              }
            },
            {
              "deletedResources": {
                "$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": "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."
          }
        }
      ]
    },
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_DeleteAtResourceGroup (updated)
Description :  Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_DeleteAtResourceGroup",
  "Description": {
    "new": "Deletes a Deployment stack by name at the specified scope. When operation completes, status code 200 returned without content.",
    "old": "Deletes a Deployment stack by name at Resource Group scope. When operation completes, status code 200 returned without content."
  },
  "$responses": {
    "202": [
      {
        "@added_5d50a0de967f463390280116ebcda333": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_ExportTemplateAtResourceGroup (updated)
Description :  Exports the template used to create the Deployment stack at the specified scope.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_ExportTemplateAtResourceGroup",
  "Description": {
    "new": "Exports the template used to create the Deployment stack at the specified scope.",
    "old": "Exports the template used to create the Deployment stack at Resource Group scope."
  },
  "$responses": {
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
template:
{
Description: The template content. Use this element to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error 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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentStacks_ValidateStackAtResourceGroup (updated)
Description :  Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeploymentStacks_ValidateStackAtResourceGroup",
  "Description": {
    "new": "Runs preflight validation on the Deployment stack template at the specified scope to verify its acceptance to Azure Resource Manager.",
    "old": "Runs preflight validation on the Resource Group scoped Deployment stack template to verify its acceptance to Azure Resource Manager."
  },
  "$parameters": [
    {
      "#name": "deploymentStack",
      "Description": {
        "new": "The content of the action request",
        "old": "Deployment stack to validate."
      },
      "$schema": {
        "$properties": [
          {
            "properties": [
              {
                "actionOnUnmanage": [
                  {
                    "#name": "resources",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "resourceGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "managementGroups",
                    "Enum": {
                      "new": [
                        [
                          "delete",
                          "Delete the specified resources from Azure"
                        ],
                        [
                          "detach",
                          "Keep the specified resources in Azure"
                        ]
                      ],
                      "old": [
                        [
                          "delete",
                          ""
                        ],
                        [
                          "detach",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#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",
                      ""
                    ],
                    [
                      "updatingDenyAssignments",
                      ""
                    ],
                    [
                      "deletingResources",
                      ""
                    ],
                    [
                      "succeeded",
                      ""
                    ],
                    [
                      "failed",
                      ""
                    ],
                    [
                      "canceled",
                      ""
                    ],
                    [
                      "deleting",
                      ""
                    ]
                  ]
                }
              },
              {
                "detachedResources": {
                  "$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."
                      }
                    }
                  ]
                }
              },
              {
                "deletedResources": {
                  "$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": "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."
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_fcf379b46a0b45ac94097a11d1fdb261": {
          "#name": "id",
          "Description": "String Id used to locate any resource on Azure.",
          "Required": false,
          "Type": "string"
        },
        "@added_566842afcca34e77b9bc55bce1ec830d": {
          "#name": "name",
          "Description": "Name of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_4ebd35a044dd43f2b896a68dd2f472f7": {
          "#name": "type",
          "Description": "Type of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_8dbf68111f384dbe9f6820aceec308ba": {
          "#name": "systemData",
          "Description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_3320875b8eaf4e96a96b8d80b71b891e": {
          "#name": "error",
          "Description": "The error detail.",
          "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": {
                "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"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#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"
                  }
                ]
              }
            }
          ]
        },
        "properties": [
          {
            "actionOnUnmanage": [
              {
                "#name": "resources",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "resourceGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "managementGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "validatedResources": {
              "$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."
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "202": [
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Number of seconds to wait before polling for status."
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ],
    "400": {
      "$properties": {
        "@added_a27a20502d8142e39b96472f02d4c81d": {
          "#name": "id",
          "Description": "String Id used to locate any resource on Azure.",
          "Required": false,
          "Type": "string"
        },
        "@added_503f513d277d4948b68e52637f49e527": {
          "#name": "name",
          "Description": "Name of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_5423a3be9abb41f9bec5d18ffb556c9f": {
          "#name": "type",
          "Description": "Type of this resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_8d4f8a5ab8f140a9a83159e04f19b171": {
          "#name": "systemData",
          "Description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_695328a22b024c39a3c6f9398c04d76c": {
          "#name": "error",
          "Description": "The error detail.",
          "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": {
                "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"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#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"
                  }
                ]
              }
            }
          ]
        },
        "properties": [
          {
            "actionOnUnmanage": [
              {
                "#name": "resources",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "resourceGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "managementGroups",
                "Enum": {
                  "new": [
                    [
                      "delete",
                      "Delete the specified resources from Azure"
                    ],
                    [
                      "detach",
                      "Keep the specified resources in Azure"
                    ]
                  ],
                  "old": [
                    [
                      "delete",
                      ""
                    ],
                    [
                      "detach",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "validatedResources": {
              "$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."
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "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": "The error detail."
          },
          "$properties": {
            "details": {
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: String Id used to locate any resource on Azure. ,
Required: False ,
}
string ,
name:
{
Description: Name of this resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of this resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource ID of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (400)

{
id:
{
Description: String Id used to locate any resource on Azure. ,
Required: False ,
}
string ,
name:
{
Description: Name of this resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of this resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
properties:
{
Description: The validation result details. ,
Required: False ,
}
{
actionOnUnmanage:
{
Description: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. ,
Required: False ,
}
{
resources:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: True ,
}
enum ,
resourceGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
managementGroups:
{
Description: Specifies an action for a newly unmanaged resource. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. ,
Enum:
{
delete: Delete the specified resources from Azure ,
detach: Keep the specified resources in Azure ,
}
,
Required: False ,
}
enum ,
}
,
correlationId:
{
Description: The correlation id of the Deployment stack validate operation. It is in GUID format and is used for tracing. ,
Required: False ,
}
string ,
denySettings:
{
Description: The Deployment stack deny settings. ,
Required: False ,
}
{
mode:
{
Description: denySettings Mode that defines denied actions. ,
Enum:
{
denyDelete: Authorized users are able to read and modify the resources, but cannot delete. ,
denyWriteAndDelete: Authorized users can read from a resource, but cannot modify or delete it. ,
none: No denyAssignments have been applied. ,
}
,
Required: True ,
}
enum ,
excludedPrincipals:
{
Description: List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. ,
Required: False ,
}
[
string ,
]
,
excludedActions:
{
Description: List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. ,
Required: False ,
}
[
string ,
]
,
applyToChildScopes:
{
Description: DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. ,
Required: False ,
}
boolean ,
}
,
deploymentScope:
{
Description: The Deployment stack deployment scope. ,
Required: False ,
}
string ,
description:
{
Description: The Deployment stack validation description. ,
Required: False ,
}
string ,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resourceId of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
validatedResources:
{
Description: The array of resources that were validated. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource ID of a resource managed by the deployment stack. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
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 ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}