You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-resource-manager/resource-manager-deployment-operations.md
+71-85Lines changed: 71 additions & 85 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ For help with resolving particular deployment errors, see [Resolve common errors
13
13
14
14
## Get deployments and correlation ID
15
15
16
-
To get details about a deployment from the deployment history use portal, PowerShell, Azure CLI, or REST API.
16
+
You can view details about a deployment through the Azure portal, PowerShell, Azure CLI, or REST API. Each deployment has a correlation ID, which is used to track related events. It can be helpful when working with technical support to troubleshoot a deployment.
17
17
18
18
# [Portal](#tab/azure-portal)
19
19
@@ -27,7 +27,7 @@ To get details about a deployment from the deployment history use portal, PowerS
1. A summary of the deployment is displayed, including the correlation ID. The correlation ID is used to track related events, and can be helpful when working with technical support to troubleshoot a deployment.
30
+
1. A summary of the deployment is displayed, including the correlation ID.
The correlation ID is used to track related events. It can be helpful when working with technical support to troubleshoot a deployment. To get the correlation ID, use:
@@ -65,155 +65,141 @@ To get a specific deployment, use the [azure group deployment show](/cli/azure/g
65
65
az group deployment show --resource-group ExampleGroup --name ExampleDeployment
66
66
```
67
67
68
-
The correlation ID is used to track related events. It can be helpful when working with technical support to troubleshoot a deployment. To get the correlation ID, use:
68
+
To get the correlation ID, use:
69
69
70
70
```azurecli-interactive
71
71
az group deployment show --resource-group ExampleGroup --name ExampleDeployment --query properties.correlationId
72
72
```
73
73
74
74
# [HTTP](#tab/http)
75
75
76
-
To list the deployments for a resource group, use the [Deployments - List By Resource Group](/rest/api/resources/deployments/listbyresourcegroup) operation.
76
+
To list the deployments for a resource group, use the following operation. For the latest API version number to use in the request, see [Deployments - List By Resource Group](/rest/api/resources/deployments/listbyresourcegroup).
77
77
78
78
```
79
79
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/?api-version={api-version}
80
80
```
81
81
82
-
To get a specific deployment. use the [Deployments - Get](/rest/api/resources/deployments/get) operation.
82
+
To get a specific deployment. use the following operation. For the latest API version number to use in the request, see [Deployments - Get](/rest/api/resources/deployments/get).
83
83
84
84
```
85
85
GET https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{resource-group-name}/providers/microsoft.resources/deployments/{deployment-name}?api-version={api-version}
86
86
```
87
87
88
-
The response includes the correlation ID, which is used to track related events. It can be helpful when working with technical support to troubleshoot a deployment.
"code":"DeploymentFailed","message":"At least one resource deployment operation failed. Please list deployment operations for details. Please see https://aka.ms/arm-debug for usage details.",
To get details about a deployment from the deployment history use portal, PowerShell, Azure CLI, or REST API.
108
+
Each deployment can include multiple operations. Each operation represents a step in the deployment process. To see more details about a deployment, view the deployment operations. When a deployment fails, the deployment operations include an error message.
110
109
111
110
# [Portal](#tab/azure-portal)
112
111
113
112
1. On the summary for a deployment, select **Operation details**.
Each deployment includes multiple operations. Each operation represents a step in the deployment process. To discover what went wrong with a deployment, you usually need to see details about the deployment operations. You can see the status of the operations with **Get-AzResourceGroupDeploymentOperation**.
122
+
To view the deployment operations for deploymentto a resource group, use the [Get-AzResourceGroupDeploymentOperation](/powershell/module/az.resources/get-azdeploymentoperation) command.
The following example shows how to get deployment operations. For documentation about the latest API version, see the [Deployment Operations - List](/rest/api/resources/deploymentoperations/list) operation.
140
-
141
-
```
142
-
GET https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{resource-group-name}/providers/microsoft.resources/deployments/{deployment-name}/operations?$skiptoken={skiptoken}&api-version={api-version}
143
-
```
144
-
145
-
The response includes request and/or response information based on what you specified in the **debugSetting** property during deployment.
134
+
To get the status message of failed operations, use the following command:
To view the deployment operations for deployment to a resource group, use the [az group deployment operation list](/cli/azure/group/deployment/operation) command.
177
143
144
+
```azurecli-interactive
145
+
az group deployment operation list --resource-group ExampleGroup --name ExampleDeployment
146
+
```
178
147
179
-
To get more details about failed operations, retrieve the properties for operations with **Failed** state.
148
+
To view failed operations, filter operations with **Failed** state.
az group deployment operation list --resource-group ExampleGroup --name ExampleDeploy --query "[?properties.provisioningState=='Failed'].properties.statusMessage.error"
199
158
```
200
159
201
-
Note the serviceRequestId and the trackingId for the operation. The serviceRequestId can be helpful when working with technical support to troubleshoot a deployment. You'll use the trackingId in the next step to focus on a particular operation.
160
+
# [HTTP](#tab/http)
202
161
203
-
To get the status message of a particular failed operation, use the following command:
162
+
To get deployment operations, use the following operation. For the latest API version number to use in the request, see [Deployment Operations - List](/rest/api/resources/deploymentoperations/list).
GET https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{resource-group-name}/providers/microsoft.resources/deployments/{deployment-name}/operations?$skiptoken={skiptoken}&api-version={api-version}
207
166
```
208
167
209
-
Which returns:
168
+
The response includes an error message.
210
169
211
-
```powershell
212
-
code message details
213
-
---- ------- -------
214
-
DnsRecordInUse DNS record dns.westus.cloudapp.azure.com is already used by another public IP. {}
0 commit comments