Skip to content

Commit 58c5ea3

Browse files
authored
Merge pull request #210887 from davidsmatlak/ds-fix-headings-0912
Fixes headings and edits
2 parents 7bd6713 + cca1edc commit 58c5ea3

File tree

5 files changed

+41
-41
lines changed

5 files changed

+41
-41
lines changed

articles/azure-resource-manager/troubleshooting/error-invalid-template.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Invalid template errors
33
description: Describes how to resolve invalid template errors when deploying Bicep files or Azure Resource Manager templates (ARM templates).
44
ms.topic: troubleshooting
5-
ms.date: 12/20/2021
5+
ms.date: 09/12/2022
66
---
77

88
# Resolve errors for invalid template
@@ -26,7 +26,7 @@ This error can result from several different types of errors. They usually invol
2626

2727
<a id="syntax-error"></a>
2828

29-
## Solution 1 - syntax error
29+
## Solution 1: Syntax error
3030

3131
If you receive an error message that indicates the template failed validation, you may have a syntax problem in your template.
3232

@@ -56,13 +56,13 @@ When you receive this type of error, review the expression's syntax. To identify
5656

5757
<a id="incorrect-segment-lengths"></a>
5858

59-
## Solution 2 - incorrect segment lengths
59+
## Solution 2: Incorrect segment lengths
6060

6161
Another invalid template error occurs when the resource name isn't in the correct format. To resolve that error, see [Resolve errors for name and type mismatch](error-invalid-name-segments.md).
6262

6363
<a id="parameter-not-valid"></a>
6464

65-
## Solution 3 - parameter isn't valid
65+
## Solution 3: Parameter isn't valid
6666

6767
You can specify a parameter's allowed values in a template. During deployment, if you provide a value that isn't an allowed value, you receive a message similar to the following error:
6868

@@ -77,13 +77,13 @@ Check the template for the parameter's allowed values, and use an allowed value
7777

7878
<a id="too-many-resource-groups"></a>
7979

80-
## Solution 4 - too many target resource groups
80+
## Solution 4: Too many target resource groups
8181

8282
You may see this error in earlier deployments because you were limited to five target resource groups in a single deployment. In May 2020, that limit was increased to 800 resource groups. For more information, see how to deploy to multiple resource groups for [Bicep](../bicep/deploy-to-resource-group.md#deploy-to-multiple-resource-groups) or [ARM templates](../templates/deploy-to-resource-group.md#deploy-to-multiple-resource-groups).
8383

8484
<a id="circular-dependency"></a>
8585

86-
## Solution 5 - circular dependency detected
86+
## Solution 5: Circular dependency detected
8787

8888
You receive this error when resources depend on each other in a way that prevents the deployment from starting. A combination of interdependencies makes two or more resource wait for other resources that are also waiting. For example, resource1 depends on resource3, resource2 depends on resource1, and resource3 depends on resource2. You can usually solve this problem by removing unnecessary dependencies.
8989

articles/azure-resource-manager/troubleshooting/error-job-size-exceeded.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Job size exceeded error
3-
description: Describes how to troubleshoot errors when job size or template are too large for deployments using a Bicep file or Azure Resource Manager template (ARM template).
3+
description: Describes how to troubleshoot errors for job size exceeded or if the template is too large for deployments using a Bicep file or Azure Resource Manager template (ARM template).
44
ms.topic: troubleshooting
5-
ms.date: 12/20/2021
5+
ms.date: 09/12/2022
66
---
77

88
# Resolve errors for job size exceeded
99

10-
This article describes how to resolve the `JobSizeExceededException` and `DeploymentJobSizeExceededException` errors. The errors can occur when you deploy a Bicep file or Azure Resource Manager template (ARM template).
10+
This article describes how to resolve the `JobSizeExceededException` and `DeploymentJobSizeExceededException` errors. The job size exceeded errors can occur when you deploy a Bicep file or Azure Resource Manager template (ARM template).
1111

1212
## Symptom
1313

@@ -29,7 +29,7 @@ Other template limits are:
2929
- 64 output values
3030
- 24,576 characters in a template expression
3131

32-
## Solution 1 - use dependencies carefully
32+
## Solution 1: Use dependencies carefully
3333

3434
# [Bicep](#tab/bicep)
3535

@@ -53,7 +53,7 @@ dependsOn: [
5353

5454
---
5555

56-
## Solution 2 - simplify template
56+
## Solution 2: Simplify template
5757

5858
# [Bicep](#tab/bicep)
5959

@@ -70,7 +70,7 @@ You can set other resources as dependent on the linked template, and [get values
7070

7171
---
7272

73-
## Solution 3 - reduce name size
73+
## Solution 3: Reduce name size
7474

7575
# [Bicep](#tab/bicep)
7676

articles/azure-resource-manager/troubleshooting/error-not-found.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: Resource not found errors
33
description: Describes how to resolve errors when a resource can't be found. The error might occur when you deploy a Bicep file or Azure Resource Manager template, or when doing management tasks.
44
ms.topic: troubleshooting
5-
ms.date: 11/30/2021
5+
ms.date: 09/12/2022
66
ms.custom: devx-track-azurepowershell
77
---
88

9-
# Resolve Resource Not Found errors
9+
# Resolve errors for resource not found
1010

1111
This article describes the error you see when a resource can't be found during an operation. Typically, you see this error when deploying resources with a Bicep file or Azure Resource Manager template (ARM template). You also see this error when doing management tasks and Azure Resource Manager can't find the required resource. For example, if you try to add tags to a resource that doesn't exist, you receive this error.
1212

@@ -31,7 +31,7 @@ group {resource group name} was not found.
3131

3232
Resource Manager needs to retrieve the properties for a resource, but can't find the resource in your subscription.
3333

34-
## Solution 1 - Check resource properties
34+
## Solution 1: Check resource properties
3535

3636
When you receive this error while doing a management task, check the values you provided for the resource. The three values to check are:
3737

@@ -43,7 +43,7 @@ If you're using PowerShell or Azure CLI, check that you're running commands in t
4343

4444
If you can't verify the properties, sign in to the [Microsoft Azure portal](https://portal.azure.com). Find the resource you're trying to use and examine the resource name, resource group, and subscription.
4545

46-
## Solution 2 - Set Dependencies
46+
## Solution 2: Set dependencies
4747

4848
If you get this error when deploying a template, you may need to add a dependency. Resource Manager optimizes deployments by creating resources in parallel, when possible.
4949

@@ -56,13 +56,13 @@ Use an [implicit dependency](../bicep/resource-dependencies.md#implicit-dependen
5656
For example, the web app's `serverFarmId` property uses `servicePlan.id` to create a dependency on the App Service plan.
5757

5858
```bicep
59-
resource webApp 'Microsoft.Web/sites@2021-02-01' = {
59+
resource webApp 'Microsoft.Web/sites@2022-03-01' = {
6060
properties: {
6161
serverFarmId: servicePlan.id
6262
}
6363
}
6464
65-
resource servicePlan 'Microsoft.Web/serverfarms@2021-02-01' = {
65+
resource servicePlan 'Microsoft.Web/serverfarms@2022-03-01' = {
6666
name: hostingPlanName
6767
...
6868
```
@@ -73,12 +73,12 @@ Avoid setting dependencies that aren't needed. Unnecessary dependencies prolong
7373

7474
# [JSON](#tab/json)
7575

76-
If one resource must be deployed after another resource, you need to use the [dependsOn](../templates/resource-dependency.md#dependson) element in your template.
76+
If a resource must be deployed after another resource, use the [dependsOn](../templates/resource-dependency.md#dependson) element in your template.
7777

7878
```json
7979
{
8080
"type": "Microsoft.Web/sites",
81-
"apiVersion": "2021-02-01",
81+
"apiVersion": "2022-03-01",
8282
"dependsOn": [
8383
"[variables('hostingPlanName')]"
8484
],
@@ -107,15 +107,15 @@ When you see dependency problems, you need to gain insight into the order of res
107107

108108
:::image type="content" source="media/error-not-found/select-deployment-events.png" alt-text="Screenshot that highlights the link to a deployment's related events.":::
109109

110-
1. Examine the sequence of events for each resource. Pay attention to the status of each operation and it's time stamp. For example, the following image shows three storage accounts that deployed in parallel. Notice that the three storage accounts are started at the same time.
110+
1. Examine the sequence of events for each resource. Pay attention to the status of each operation and it's time stamp. For example, the following image shows three storage accounts that deployed in parallel. Notice that the three storage account deployments started at the same time.
111111

112112
:::image type="content" source="media/error-not-found/deployment-events-parallel.png" alt-text="Screenshot of activity log for resources deployed in parallel.":::
113113

114114
The next image shows three storage accounts that aren't deployed in parallel. The second storage account depends on the first storage account, and the third storage account depends on the second storage account. The first storage account is labeled **Started**, **Accepted**, and **Succeeded** before the next is started.
115115

116116
:::image type="content" source="media/error-not-found/deployment-events-sequence.png" alt-text="Screenshot of activity log for resources deployed in sequential order.":::
117117

118-
## Solution 3 - Get external resource
118+
## Solution 3: Get external resource
119119

120120
# [Bicep](#tab/bicep)
121121

@@ -124,12 +124,12 @@ Bicep uses the symbolic name to create an [implicit dependency](../bicep/resourc
124124
In this example, a web app is deployed that uses an existing App Service plan from another resource group.
125125

126126
```bicep
127-
resource servicePlan 'Microsoft.Web/serverfarms@2021-02-01' existing = {
127+
resource servicePlan 'Microsoft.Web/serverfarms@2022-03-01' existing = {
128128
name: hostingPlanName
129129
scope: resourceGroup(rgname)
130130
}
131131
132-
resource webApp 'Microsoft.Web/sites@2021-02-01' = {
132+
resource webApp 'Microsoft.Web/sites@2022-03-01' = {
133133
name: siteName
134134
properties: {
135135
serverFarmId: servicePlan.id
@@ -154,7 +154,7 @@ The following example gets the resource ID for a resource that exists in a diffe
154154

155155
---
156156

157-
## Solution 4 - Get managed identity from resource
157+
## Solution 4: Get managed identity from resource
158158

159159
# [Bicep](#tab/bicep)
160160

@@ -188,18 +188,18 @@ The pattern is:
188188
For example, to get the principal ID for a managed identity that is applied to a virtual machine, use:
189189

190190
```json
191-
"[reference(resourceId('Microsoft.Compute/virtualMachines', variables('vmName')), '2021-07-01', 'Full').identity.principalId]",
191+
"[reference(resourceId('Microsoft.Compute/virtualMachines', variables('vmName')), '2022-03-01', 'Full').identity.principalId]",
192192
```
193193

194194
Or, to get the tenant ID for a managed identity that is applied to a virtual machine scale set, use:
195195

196196
```json
197-
"[reference(resourceId('Microsoft.Compute/virtualMachineScaleSets', variables('vmNodeType0Name')), '2021-07-01', 'Full').Identity.tenantId]"
197+
"[reference(resourceId('Microsoft.Compute/virtualMachineScaleSets', variables('vmNodeType0Name')), '2022-03-01', 'Full').Identity.tenantId]"
198198
```
199199

200200
---
201201

202-
## Solution 5 - Check functions
202+
## Solution 5: Check functions
203203

204204
# [Bicep](#tab/bicep)
205205

@@ -208,23 +208,23 @@ You can use a resource's symbolic name to get values from a resource. You can re
208208
The following example references an existing storage account in a different resource group.
209209

210210
```bicep
211-
resource stgAcct 'Microsoft.Storage/storageAccounts@2021-06-01' existing = {
211+
resource stgAcct 'Microsoft.Storage/storageAccounts@2022-05-01' existing = {
212212
name: stgname
213213
scope: resourceGroup(rgname)
214214
}
215215
```
216216

217217
# [JSON](#tab/json)
218218

219-
When deploying a template, look for expressions that use the [reference](../templates/template-functions-resource.md#reference) or [listKeys](../templates/template-functions-resource.md#listkeys) functions. The values you provide vary based on whether the resource is in the same template, resource group, and subscription. Check that you're providing the required parameter values for your scenario. If the resource is in a different resource group, provide the full resource ID. For example, to reference a storage account in another resource group, use:
219+
When you deploy a template, look for expressions that use the [reference](../templates/template-functions-resource.md#reference) or [listKeys](../templates/template-functions-resource.md#listkeys) functions. The values you provide vary based on whether the resource is in the same template, resource group, and subscription. Check that you're providing the required parameter values for your scenario. If the resource is in a different resource group, provide the full resource ID. For example, to reference a storage account in another resource group, use:
220220

221221
```json
222-
"[reference(resourceId('exampleResourceGroup', 'Microsoft.Storage/storageAccounts', 'myStorage'), '2021-06-01')]"
222+
"[reference(resourceId('exampleResourceGroup', 'Microsoft.Storage/storageAccounts', 'myStorage'), '2022-05-01')]"
223223
```
224224

225225
---
226226

227-
## Solution 6 - After deleting resource
227+
## Solution 6: After deleting resource
228228

229229
When you delete a resource, there might be a short amount of time when the resource appears in the portal but isn't available. If you select the resource, you'll get an error that the resource is **Not found**.
230230

articles/azure-resource-manager/troubleshooting/error-parent-resource.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Parent resource errors
33
description: Describes how to resolve errors when you deploy a resource that's dependent on a parent resource in a Bicep file or Azure Resource Manager template (ARM template).
44
ms.topic: troubleshooting
5-
ms.date: 12/20/2021
5+
ms.date: 09/12/2022
66
---
77

88
# Resolve errors for parent resources
@@ -25,7 +25,7 @@ When one resource is a child to another resource, the parent resource must exist
2525
# [Bicep](#tab/bicep)
2626

2727
```bicep
28-
resource sqlDatabase 'Microsoft.Sql/servers/databases@2021-05-01-preview' = {
28+
resource sqlDatabase 'Microsoft.Sql/servers/databases@2022-02-01-preview' = {
2929
name: '${sqlServerName}/${databaseName}'
3030
...
3131
}
@@ -50,7 +50,7 @@ If you deploy the server and the database in the same template, but don't specif
5050

5151
If the parent resource already exists and isn't deployed in the same template, you get the `ParentResourceNotFound` error when Resource Manager can't associate the child resource with a parent. This error might happen when the child resource isn't in the correct format. Or if the child resource is deployed to a resource group that's different than the resource group for parent resource.
5252

53-
## Solution 1 - deployed in same template
53+
## Solution 1: Deployed in same template
5454

5555
To resolve this error when parent and child resources are deployed in the same template, use a dependency.
5656

@@ -59,7 +59,7 @@ To resolve this error when parent and child resources are deployed in the same t
5959
This example uses a nested child resource within the parent resource and that creates the dependency. The child gets the resource type and API version from the parent resource.
6060

6161
```bicep
62-
resource sqlServer 'Microsoft.Sql/servers@2021-05-01-preview' = {
62+
resource sqlServer 'Microsoft.Sql/servers@2022-02-01-preview' = {
6363
name: sqlServerName
6464
properties: {
6565
...
@@ -87,7 +87,7 @@ For more information about `dependsOn`, see [Define the order for deploying reso
8787

8888
---
8989

90-
## Solution 2 - deployed in different templates
90+
## Solution 2: Deployed in different templates
9191

9292
To resolve this error when the parent resource was deployed in a different template, don't set a dependency. Instead, deploy the child to the same resource group and provide the name of the parent resource.
9393

@@ -100,11 +100,11 @@ param location string = resourceGroup().location
100100
param sqlServerName string
101101
param databaseName string
102102
103-
resource sqlServer 'Microsoft.Sql/servers@2021-05-01-preview' existing = {
103+
resource sqlServer 'Microsoft.Sql/servers@2022-02-01-preview' existing = {
104104
name: sqlServerName
105105
}
106106
107-
resource sqlDatabase 'Microsoft.Sql/servers/databases@2021-05-01-preview' = {
107+
resource sqlDatabase 'Microsoft.Sql/servers/databases@2022-02-01-preview' = {
108108
parent: sqlServer
109109
name: databaseName
110110
location: location
@@ -130,7 +130,7 @@ The `name` element uses the names of the parent resource and child resources.
130130
"resources": [
131131
{
132132
"type": "Microsoft.Sql/servers/databases",
133-
"apiVersion": "2021-05-01-preview",
133+
"apiVersion": "2022-02-01-preview",
134134
"name": "[concat(parameters('sqlServerName'), '/', parameters('databaseName'))]",
135135
"location": "[resourceGroup().location]",
136136
"properties": {

articles/azure-resource-manager/troubleshooting/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
href: error-job-size-exceeded.md
3333
- name: No registered provider found
3434
href: error-register-resource-provider.md
35-
- name: Not found
35+
- name: Resource not found
3636
href: error-not-found.md
3737
- name: Parent resource not found
3838
href: error-parent-resource.md

0 commit comments

Comments
 (0)