Skip to content

Commit ac13a54

Browse files
authored
Merge pull request #2717 from msmbaldwin/audit-kv-general-docset
Audit key-vault/general docset: fix content debt and style issues
2 parents d4e77f9 + 9711cad commit ac13a54

39 files changed

Lines changed: 330 additions & 332 deletions

articles/key-vault/general/access-behind-firewall.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: Access Key Vault behind a firewall - Azure Key Vault | Microsoft Docs
2+
title: Access Key Vault behind a firewall - Azure Key Vault
33
description: Learn about the ports, hosts, or IP addresses to open to enable a key vault client application behind a firewall to access a key vault.
44
services: key-vault
55
author: msmbaldwin
66

77
ms.service: azure-key-vault
88
ms.subservice: general
99
ms.topic: how-to
10-
ms.date: 01/30/2026
10+
ms.date: 04/10/2026
1111
ms.author: mbaldwin
1212

1313
---

articles/key-vault/general/alert.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: msmbaldwin
77
ms.service: azure-key-vault
88
ms.subservice: general
99
ms.topic: how-to
10-
ms.date: 04/16/2025
10+
ms.date: 04/10/2026
1111
ms.author: mbaldwin
1212
ms.custom: sfi-image-nochange
1313
# Customer intent: As a key vault administrator, I want to learn the options available to monitor the health of my vaults.
@@ -37,23 +37,23 @@ This article focuses on alerts for Key Vault. For information about Key Vault in
3737
An action group is a configurable list of notifications and properties. The first step in configuring alerts is to create an action group and choose an alert type:
3838

3939
1. Sign in to the Azure portal.
40-
2. Search for **Alerts** in the search box.
41-
3. Select **Manage actions**.
40+
1. Search for **Alerts** in the search box.
41+
1. Select **Manage actions**.
4242

4343
> [!div class="mx-imgBorder"]
4444
> ![Screenshot that highlights the Manage Actions button.](../media/alert-6.png)
4545
46-
4. Select **+ Add action group**.
46+
1. Select **+ Add action group**.
4747

4848
> [!div class="mx-imgBorder"]
4949
> ![Screenshot that highlights the button for adding an action group.](../media/alert-7.png)
5050
51-
5. Choose the **Action Type** value for your action group. In this example, we'll create an email and SMS alert. Select **Email/SMS/Push/Voice**.
51+
1. Choose the **Action Type** value for your action group. In this example, we'll create an email and SMS alert. Select **Email/SMS/Push/Voice**.
5252

5353
> [!div class="mx-imgBorder"]
5454
> ![Screenshot that highlights the selections for adding an action group.](../media/alert-8.png)
5555
56-
6. In the dialog, enter email and SMS details, and then select **OK**.
56+
1. In the dialog, enter email and SMS details, and then select **OK**.
5757

5858
> [!div class="mx-imgBorder"]
5959
> ![Screenshot that shows selections for adding an email and S M S message alert.](../media/alert-9.png)
@@ -67,20 +67,20 @@ Next, create a rule and configure the thresholds that will trigger an alert:
6767
> [!div class="mx-imgBorder"]
6868
> ![Screenshot that shows the Alerts menu option in the Monitoring section.](../media/alert-10.png)
6969
70-
2. Select **New alert rule**.
70+
1. Select **New alert rule**.
7171

7272
> [!div class="mx-imgBorder"]
7373
> ![Screenshot that shows the button for adding a new alert rule.](../media/alert-11.png)
7474
75-
3. Select the scope of your alert rule. You can select a single vault or multiple vaults.
75+
1. Select the scope of your alert rule. You can select a single vault or multiple vaults.
7676

7777
> [!IMPORTANT]
7878
> When you're selecting multiple vaults for the scope of your alerts, all selected vaults must be in the same region. You have to configure separate alert rules for vaults in different regions.
7979
8080
> [!div class="mx-imgBorder"]
8181
> ![Screenshot that shows how you can select a vault.](../media/alert-12.png)
8282
83-
4. Select the thresholds that define the logic for your alerts, and then select **Add**. The Key Vault team recommends configuring the following thresholds for most applications, but you can adjust them based on your application needs:
83+
1. Select the thresholds that define the logic for your alerts, and then select **Add**. The Key Vault team recommends configuring the following thresholds for most applications, but you can adjust them based on your application needs:
8484

8585
+ Key Vault availability drops below 100 percent (static threshold)
8686
> [!IMPORTANT]

articles/key-vault/general/apps-api-keys-secrets.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: orin-thomas
66
ms.service: azure-key-vault
77
ms.subservice: general
88
ms.topic: overview
9-
ms.date: 03/26/2026
9+
ms.date: 04/10/2026
1010
ms.author: orthomas
1111
---
1212

@@ -46,7 +46,7 @@ az keyvault secret set \
4646

4747
The following uses the Azure PowerShell [Set-AzKeyVaultSecret](/powershell/module/az.keyvault/set-azkeyvaultsecret) cmdlet to add a secret named MyApiKey to the keyvault and sets the secret to expire after 180 days:
4848

49-
```powershell
49+
```azurepowershell
5050
$secret = ConvertTo-SecureString -String "<secret-value>" -AsPlainText -Force
5151
Set-AzKeyVaultSecret -VaultName "<vault-name>" -Name "MyApiKey" -SecretValue $secret -Expires (Get-Date).AddDays(180)
5252
```
@@ -73,7 +73,7 @@ az role assignment create --role "Key Vault Secrets User" \
7373

7474
To do this configure an Azure role-based access control (Azure RBAC) role using the Azure PowerShell [New-AzRoleAssignment](/powershell/module/az.resources/new-azroleassignment) cmdlet:
7575

76-
```powershell
76+
```azurepowershell
7777
New-AzRoleAssignment -RoleDefinitionName "Key Vault Secrets User" `
7878
-ObjectId <object-id-of-app-or-user> `
7979
-Scope "/subscriptions/<subscription-id>/resourcegroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>"
@@ -101,7 +101,7 @@ az monitor diagnostic-settings create \
101101

102102
To enable Azure Key Vault Logging and Alerts, use the Azure PowerShell [Set-AzDiagnosticSetting](/powershell/module/az.monitor/set-azdiagnosticsetting) cmdlet:
103103

104-
```powershell
104+
```azurepowershell
105105
Set-AzDiagnosticSetting -Name "myDiagnosticSettings" `
106106
-ResourceId <key-vault-resource-id> `
107107
-WorkspaceId <log-analytics-workspace-id> `
@@ -129,7 +129,7 @@ az monitor scheduled-query create \
129129

130130
You can run the Azure PowerShell [New-AzScheduledQueryRule](/powershell/module/az.monitor/new-azscheduledqueryrule) cmdlet to monitor logs in the specified Log Analytics workspace for unauthorized access attempts to Azure Key Vault secrets and trigger an alert if any matching unauthorized access attempt is detected:
131131

132-
```powershell
132+
```azurepowershell
133133
New-AzScheduledQueryRule -ResourceGroupName "<resource-group>" `
134134
-Location "eastus" `
135135
-Action `
@@ -178,7 +178,7 @@ az keyvault network-rule add \
178178
# [Azure PowerShell](#tab/azure-powershell)
179179
You can create a private endpoint using the Azure PowerShell [New-AzPrivateEndpoint](/powershell/module/az.network/new-azprivateendpoint) cmdlet:
180180

181-
```powershell
181+
```azurepowershell
182182
$privateEndpoint = New-AzPrivateEndpoint -Name "myPrivateEndpoint" `
183183
-ResourceGroupName "<resource-group>" `
184184
-Location "eastus" `
@@ -190,7 +190,7 @@ $privateEndpoint = New-AzPrivateEndpoint -Name "myPrivateEndpoint" `
190190
```
191191
You can create firewall rules on the Azure Key Vault instance using the Azure PowerShell [Add-AzKeyVaultNetworkRule](/powershell/module/az.keyvault/add-azkeyvaultnetworkrule) cmdlet, substituting the appropriate key vault names, resource groups, subnet, and subnet mask information:
192192

193-
```powershell
193+
```azurepowershell
194194
Add-AzKeyVaultNetworkRule -VaultName "<vault-name>" `
195195
-ResourceGroupName "<resource-group>" `
196196
-IPAddress "<trusted-ip-address>/32"

articles/key-vault/general/authentication-requests-and-responses.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: msmbaldwin
77
ms.service: azure-key-vault
88
ms.subservice: general
99
ms.topic: concept-article
10-
ms.date: 03/26/2026
10+
ms.date: 04/10/2026
1111
ms.author: mbaldwin
1212

1313
---
@@ -18,7 +18,7 @@ Azure Key Vault provides two types of containers to store and manage secrets for
1818

1919
|Container type|Supported object types|Data-plane endpoint|
2020
|--|--|--|
21-
| **Vaults**|<ul><li>Software-protected keys</li><li>HSM-protected keys (with Premium SKU)</li><li>Certificates</li><li>Storage account keys</li></ul> | `https://<vault-name>.vault.azure.net`
21+
| **Vaults**|<ul><li>Software-protected keys</li><li>HSM-protected keys (with Premium SKU)</li><li>Certificates</li></ul> | `https://<vault-name>.vault.azure.net`
2222
|**Managed HSM** |<ul><li>HSM-protected keys</li></ul> | `https://<hsm-name>.managedhsm.azure.net`
2323

2424
Here are the suffixes of the URLs used to access each type of object
@@ -29,7 +29,6 @@ Here are the suffixes of the URLs used to access each type of object
2929
|HSM-protected keys| /keys |
3030
|Secrets|/secrets|
3131
|Certificates| /certificates|
32-
|Storage account keys|/storageaccounts
3332

3433
Azure Key Vault supports JSON formatted requests and responses. Requests to the Azure Key Vault are directed to a valid Azure Key Vault URL using HTTPS with some URL parameters and JSON encoded request and response bodies.
3534

articles/key-vault/general/autorotation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.author: mbaldwin
77
ms.service: azure-key-vault
88
ms.subservice: general
99
ms.topic: concept-article
10-
ms.date: 05/08/2025
10+
ms.date: 04/10/2026
1111
---
1212

1313
# Understanding autorotation in Azure Key Vault
@@ -77,12 +77,12 @@ Certificate autorotation supports:
7777
When implementing autorotation in Azure Key Vault, consider these best practices:
7878

7979
1. **Use versioning**: Ensure systems reference the latest version of a key, certificate, or secret automatically
80-
2. **Implement proper access controls**: Use Azure RBAC to control who can configure rotation policies
81-
3. **Monitor rotation events**: Set up notifications and alerts for successful and failed rotations
82-
4. **Test rotation procedures**: Validate that dependent systems can handle rotated assets correctly
83-
5. **Configure appropriate rotation frequencies**: Balance security requirements with operational considerations
84-
6. **Document fallback procedures**: Have manual rotation processes documented for emergency scenarios
85-
7. **Follow security best practices**: Implement comprehensive security measures as outlined in [Secure your Azure Key Vault](secure-key-vault.md)
80+
1. **Implement proper access controls**: Use Azure RBAC to control who can configure rotation policies
81+
1. **Monitor rotation events**: Set up notifications and alerts for successful and failed rotations
82+
1. **Test rotation procedures**: Validate that dependent systems can handle rotated assets correctly
83+
1. **Configure appropriate rotation frequencies**: Balance security requirements with operational considerations
84+
1. **Document fallback procedures**: Have manual rotation processes documented for emergency scenarios
85+
1. **Follow security best practices**: Implement comprehensive security measures as outlined in [Secure your Azure Key Vault](secure-key-vault.md)
8686

8787
## Common autorotation scenarios
8888

0 commit comments

Comments
 (0)