Skip to content

Commit 84e3abe

Browse files
authored
Merge pull request #205981 from JackStromberg/patch-76
Article split + Acrolinx fixes
2 parents 9c2f5b0 + 0334b20 commit 84e3abe

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

articles/application-gateway/application-gateway-key-vault-common-errors.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ description: This article identifies key vault-related problems, and helps you r
55
author: jaesoni
66
ms.service: application-gateway
77
ms.topic: reference
8-
ms.date: 07/12/2021
8+
ms.date: 07/26/2022
99
ms.author: jaysoni
1010

1111
---
1212

1313
# Common key vault errors in Azure Application Gateway
1414

15-
Application Gateway enables customers to securely store TLS certificates in Azure Key Vault. When using a key vault resource, it is important that the gateway always has access to the linked key vault. If your Application Gateway is unable to fetch the certificate, the associated HTTPS listeners will be placed in a disabled state. [Learn more](../application-gateway/disabled-listeners.md).
15+
Application Gateway enables customers to securely store TLS certificates in Azure Key Vault. When using a key vault resource, it's important that the gateway always has access to the linked key vault. If your Application Gateway is unable to fetch the certificate, the associated HTTPS listeners will be placed in a disabled state. [Learn more](../application-gateway/disabled-listeners.md).
1616

1717
This article helps you understand the details of the error codes and the steps to resolve such key vault misconfigurations.
1818

1919
> [!TIP]
2020
> Use a secret identifier that doesn't specify a version. This way, Azure Application Gateway will automatically rotate the certificate, if a newer version is available in Azure Key Vault. An example of a secret URI without a version is: `https://myvault.vault.azure.net/secrets/mysecret/`.
2121
22-
## List of error codes and their details
22+
## Azure Advisor error codes
2323

2424
The following sections describe the various errors you might encounter. You can verify if your gateway has any such problem by visiting [**Azure Advisor**](./key-vault-certs.md#investigating-and-resolving-key-vault-errors) for your account, and use this troubleshooting article to fix the problem. We recommend configuring Azure Advisor alerts to stay informed when a key vault problem is detected for your gateway.
2525

@@ -48,11 +48,11 @@ For more information, see [Assign a Key Vault access policy by using the Azure p
4848
1. Go to the linked key vault in the Azure portal.
4949
1. Open the **Access policies** blade.
5050
1. For **Permission model**, select **Azure role-based access control**.
51-
1. After this, navigate to **Access Control (IAM)** blade to configure permissions.
51+
1. Navigate to **Access Control (IAM)** blade to configure permissions.
5252
1. **Add role assignment** for your managed identity by choosing the following<br>
5353
a. **Role**: Key Vault Secrets User<br>
5454
b. **Assign access to**: Managed identity<br>
55-
c. **Members**: select the user-assigned managed identity which you've associated with your application gateway.<br>
55+
c. **Members**: select the user-assigned managed identity that you've associated with your application gateway.<br>
5656
1. Select **Review + assign**.
5757

5858
For more information, see [Azure role-based access control in Key Vault](../key-vault/general/rbac-guide.md).
@@ -83,7 +83,7 @@ For more information, see [Azure role-based access control in Key Vault](../key-
8383
1. Open the **Certificates** pane.
8484
1. Use the **Managed deleted certificates** tab to recover a deleted certificate.
8585

86-
On the other hand, if a certificate object is permanently deleted, you will need to create a new certificate and update Application Gateway with the new certificate details. When you're configuring through the Azure CLI or Azure PowerShell, use a secret identifier URI without a version. This choice allows instances to retrieve a renewed version of the certificate, if it exists.
86+
On the other hand, if a certificate object is permanently deleted, you'll need to create a new certificate and update Application Gateway with the new certificate details. When you're configuring through the Azure CLI or Azure PowerShell, use a secret identifier URI without a version. This choice allows instances to retrieve a renewed version of the certificate, if it exists.
8787

8888
:::image type="content" source="./media/application-gateway-key-vault-common-errors/secret-deleted.png" alt-text="Screenshot that shows how to recover a deleted certificate in Key Vault.":::
8989

@@ -101,7 +101,7 @@ On the other hand, if a certificate object is permanently deleted, you will need
101101

102102
**Description:** There's a restricted network setting for Key Vault.
103103

104-
**Resolution:** You will encounter this error when you enable the Key Vault firewall for restricted access. You can still configure Application Gateway in a restricted network of Key Vault, by following these steps:
104+
**Resolution:** You'll encounter this error when you enable the Key Vault firewall for restricted access. You can still configure Application Gateway in a restricted network of Key Vault, by following these steps:
105105
1. In Key Vault, open the **Networking** pane.
106106
1. Select the **Firewalls and virtual networks** tab, and select **Private endpoint and selected networks**.
107107
1. Then, using Virtual Networks, add your Application Gateway's virtual network and subnet. During the process, also configure 'Microsoft.KeyVault' service endpoint by selecting its checkbox.
@@ -128,12 +128,12 @@ Select **Managed deleted vaults**. From here, you can find the deleted Key Vault
128128

129129
**Resolution:** Your Azure subscription can get disabled for various reasons. To take the necessary action to resolve, see [Reactivating a disabled Azure subscription](../cost-management-billing/manage/subscription-disabled.md).
130130

131-
[comment]: # (Error Code 8)
132-
### Error code: ApplicationGatewayCertificateDataOrKeyVaultSecretIdMustBeSpecified/ApplicationGatewaySslCertificateDataMustBeSpecified
131+
## Application Gateway Error Codes
132+
### Error code: ApplicationGatewayCertificateDataOrKeyVaultSecretIdMustBeSpecified / ApplicationGatewaySslCertificateDataMustBeSpecified
133133

134-
**Description:** You may encounter this error when trying to update a listener certificate. When this error occurs, the change to update the certificate will be discarded and the listener will continue to handle traffic with the previously defined configuration.
134+
**Description:** You may encounter this error when trying to update a listener certificate. When this error occurs, the change to update the certificate will be discarded, and the listener will continue to handle traffic with the previously defined configuration.
135135

136-
**Resolution:** To resolve this issue please try uploading the certificate again. For example, the following PowerShell commands may be used to update certificates uploaded to Application Gateway or referenced via Azure Key Vault.
136+
**Resolution:** To resolve this issue, please try uploading the certificate again. For example, the following PowerShell commands may be used to update certificates uploaded to Application Gateway or referenced via Azure Key Vault.
137137

138138
Update certificate uploaded directly to Application Gateway:
139139
```

0 commit comments

Comments
 (0)