Skip to content

Commit 9b998b9

Browse files
Merge pull request #2661 from msmbaldwin/placeholder-standardization-general
Standardize placeholders in key-vault/general
2 parents 9b48a8b + bddc9e9 commit 9b998b9

18 files changed

Lines changed: 178 additions & 178 deletions

articles/key-vault/general/about-keys-secrets-certificates.md

Lines changed: 3 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: overview
10-
ms.date: 01/08/2026
10+
ms.date: 03/26/2026
1111
ms.author: mbaldwin
1212
---
1313

@@ -23,10 +23,10 @@ For more information, see [Authentication, requests, and responses](authenticati
2323
An object identifier has the following general format (depending on container type):
2424

2525
- **For Vaults**:
26-
`https://{vault-name}.vault.azure.net/{object-type}/{object-name}/{object-version}`
26+
`https://<vault-name>.vault.azure.net/<object-type>/<object-name>/<object-version>`
2727

2828
- **For Managed HSM pools**:
29-
`https://{hsm-name}.managedhsm.azure.net/{object-type}/{object-name}/{object-version}`
29+
`https://<hsm-name>.managedhsm.azure.net/<object-type>/<object-name>/<object-version>`
3030

3131
> [!NOTE]
3232
> See [Object type support](#object-types) for types of objects supported by each container type.

articles/key-vault/general/access-control-default.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: mbaldwin
66
ms.service: azure-key-vault
77
ms.subservice: general
88
ms.topic: how-to
9-
ms.date: 03/24/2026
9+
ms.date: 03/26/2026
1010
ms.custom: devx-track-azurepowershell, devx-track-azurecli, sfi-image-nochange
1111

1212
#customer intent: As an Azure Key Vault administrator, I want to migrate from access policies to Azure RBAC so that I can improve security and simplify access management.
@@ -53,7 +53,7 @@ After checking your configuration:
5353
1. Use the [az keyvault show](/cli/azure/keyvault#az-keyvault-show) command to retrieve vault details:
5454

5555
```azurecli
56-
az keyvault show --name <KeyVaultName> --resource-group <ResourceGroupName>
56+
az keyvault show --name <vault-name> --resource-group <resource-group>
5757
```
5858

5959
1. Check the **Enabled for RBAC Authorization** property (`enableRbacAuthorization`) for the key vault.
@@ -78,7 +78,7 @@ Use the [az keyvault list](/cli/azure/keyvault#az-keyvault-list) command to list
7878

7979
```azurecli
8080
# List all key vaults in the resource group and check Azure RBAC status
81-
az keyvault list --resource-group <ResourceGroupName> --query "[].{name:name, rbacEnabled:properties.enableRbacAuthorization}" --output table
81+
az keyvault list --resource-group <resource-group> --query "[].{name:name, rbacEnabled:properties.enableRbacAuthorization}" --output table
8282
```
8383

8484
# [PowerShell](#tab/azure-powershell)
@@ -113,7 +113,7 @@ az keyvault list --resource-group <ResourceGroupName> --query "[].{name:name, rb
113113
1. Name the resource group you want to run your function for:
114114

115115
```azurepowershell
116-
$resourceGroupName = "<ResourceGroupName>"
116+
$resourceGroupName = "<resource-group>"
117117
```
118118

119119
1. Call function `Get-KeyVaultsFromResourceGroup` to see which vaults in the resource group from step 2 have access policies vs Azure RBAC enabled.

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

Lines changed: 29 additions & 29 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: 11/19/2025
9+
ms.date: 03/26/2026
1010
ms.author: orthomas
1111
---
1212

@@ -36,9 +36,9 @@ The following uses the Azure CLI [az keyvault secret set](/cli/azure/keyvault/se
3636

3737
```azurecli
3838
az keyvault secret set \
39-
--vault-name "<YourKeyVaultName>" \
39+
--vault-name "<vault-name>" \
4040
--name "MyApiKey" \
41-
--value "<YourSecretValue>"
41+
--value "<secret-value>"
4242
--expires "$(date -u -d '+180 days' +'%Y-%m-%dT%H:%M:%SZ')"
4343
```
4444

@@ -47,8 +47,8 @@ az keyvault secret set \
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

4949
```powershell
50-
$secret = ConvertTo-SecureString -String "<YourSecretValue>" -AsPlainText -Force
51-
Set-AzKeyVaultSecret -VaultName "<YourKeyVaultName>" -Name "MyApiKey" -SecretValue $secret -Expires (Get-Date).AddDays(180)
50+
$secret = ConvertTo-SecureString -String "<secret-value>" -AsPlainText -Force
51+
Set-AzKeyVaultSecret -VaultName "<vault-name>" -Name "MyApiKey" -SecretValue $secret -Expires (Get-Date).AddDays(180)
5252
```
5353

5454
---
@@ -66,7 +66,7 @@ To do this configure an Azure role-based access control (Azure RBAC) role using
6666
```azurecli
6767
az role assignment create --role "Key Vault Secrets User" \
6868
--assignee <object-id-of-app-or-user> \
69-
--scope /subscriptions/<subscription-id>/resourcegroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<key-vault-name>
69+
--scope /subscriptions/<subscription-id>/resourcegroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>
7070
```
7171

7272
# [Azure PowerShell](#tab/azure-powershell)
@@ -76,7 +76,7 @@ To do this configure an Azure role-based access control (Azure RBAC) role using
7676
```powershell
7777
New-AzRoleAssignment -RoleDefinitionName "Key Vault Secrets User" `
7878
-ObjectId <object-id-of-app-or-user> `
79-
-Scope "/subscriptions/<subscription-id>/resourcegroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<key-vault-name>"
79+
-Scope "/subscriptions/<subscription-id>/resourcegroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>"
8080
```
8181

8282
---
@@ -92,9 +92,9 @@ To enable Azure Key Vault Logging and Alerts, use the Azure CLI [az monitor diag
9292
```azurecli
9393
az monitor diagnostic-settings create \
9494
--name myDiagnosticSettings \
95-
--resource {key-vault-resource-id} \
95+
--resource <key-vault-resource-id> \
9696
--logs '[{"category": "AuditEvent","enabled": true}]' \
97-
--workspace {log-analytics-workspace-id}
97+
--workspace <log-analytics-workspace-id>
9898
```
9999

100100
# [Azure PowerShell](#tab/azure-powershell)
@@ -103,8 +103,8 @@ To enable Azure Key Vault Logging and Alerts, use the Azure PowerShell [Set-AzDi
103103

104104
```powershell
105105
Set-AzDiagnosticSetting -Name "myDiagnosticSettings" `
106-
-ResourceId {key-vault-resource-id} `
107-
-WorkspaceId {log-analytics-workspace-id} `
106+
-ResourceId <key-vault-resource-id> `
107+
-WorkspaceId <log-analytics-workspace-id> `
108108
-Category "AuditEvent" `
109109
-Enabled $true
110110
```
@@ -120,8 +120,8 @@ You can run the Azure CLI [az monitor scheduled-query create](/cli/azure/monitor
120120
```azurecli
121121
az monitor scheduled-query create \
122122
--name "Suspicious Access Alert" \
123-
--resource-group myResourceGroup \
124-
--scopes {log-analytics-workspace-resource-id} \
123+
--resource-group <resource-group> \
124+
--scopes <log-analytics-workspace-resource-id> \
125125
--condition "AzureDiagnostics | where ResourceType == 'VAULTS' | where OperationName == 'SecretGet' | where ResultSignature == 'Unauthorized'"
126126
```
127127

@@ -130,14 +130,14 @@ az monitor scheduled-query create \
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

132132
```powershell
133-
New-AzScheduledQueryRule -ResourceGroupName "myResourceGroup" `
133+
New-AzScheduledQueryRule -ResourceGroupName "<resource-group>" `
134134
-Location "eastus" `
135135
-Action `
136136
(New-AzScheduledQueryRuleAction -Severity 3 -Trigger `
137137
(New-AzScheduledQueryRuleTriggerCondition -ThresholdOperator GreaterThan -Threshold 0 -MetricTrigger `
138-
(New-AzScheduledQueryRuleMetricTrigger -MetricName "UnauthorizedAccess" -MetricResourceId {log-analytics-workspace-resource-id} -TimeAggregation "Count" -Operator "GreaterThan" -Threshold 0))) `
138+
(New-AzScheduledQueryRuleMetricTrigger -MetricName "UnauthorizedAccess" -MetricResourceId "<log-analytics-workspace-resource-id>" -TimeAggregation "Count" -Operator "GreaterThan" -Threshold 0))) `
139139
-Source `
140-
(New-AzScheduledQueryRuleSource -Query "AzureDiagnostics | where ResourceType == 'VAULTS' | where OperationName == 'SecretGet' | where ResultSignature == 'Unauthorized'" -DataSourceId {log-analytics-workspace-resource-id}) `
140+
(New-AzScheduledQueryRuleSource -Query "AzureDiagnostics | where ResourceType == 'VAULTS' | where OperationName == 'SecretGet' | where ResultSignature == 'Unauthorized'" -DataSourceId "<log-analytics-workspace-resource-id>") `
141141
-Schedule `
142142
(New-AzScheduledQueryRuleSchedule -FrequencyInMinutes 5 -TimeWindowInMinutes 5) `
143143
-Description "Alert for unauthorized access attempts to Key Vault secrets"
@@ -159,41 +159,41 @@ You can create a private endpoint using the Azure CLI [az network private-endpoi
159159
```azurecli
160160
az network private-endpoint create \
161161
--name myPrivateEndpoint \
162-
--resource-group myResourceGroup \
162+
--resource-group <resource-group> \
163163
--vnet-name myVNet \
164164
--subnet mySubnet \
165-
--private-connection-resource-id /subscriptions/{subscription}/resourceGroups/{rg}/providers/Microsoft.KeyVault/vaults/{key-vault-name} \
165+
--private-connection-resource-id /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name> \
166166
--group-id vault \
167167
--connection-name myConnection
168168
169169
You can create firewall rules on the Azure Key Vault instance using the Azure CLI [az keyvault network-rule add](/cli/azure/keyvault/network-rule#az-keyvault-network-rule-add) command, substituting the appropriate key vault names, resource groups, subnet, and subnet mask information:
170170
171171
```azurecli
172172
az keyvault network-rule add \
173-
--name {key-vault-name} \
174-
--resource-group myResourceGroup \
175-
--ip-address {trusted-ip-address}/32
173+
--name <vault-name> \
174+
--resource-group <resource-group> \
175+
--ip-address <trusted-ip-address>/32
176176
```
177177

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

181181
```powershell
182182
$privateEndpoint = New-AzPrivateEndpoint -Name "myPrivateEndpoint" `
183-
-ResourceGroupName "myResourceGroup" `
183+
-ResourceGroupName "<resource-group>" `
184184
-Location "eastus" `
185-
-SubnetId "/subscriptions/{subscription}/resourceGroups/{rg}/providers/Microsoft.Network/virtualNetworks/{vnet-name}/subnets/{subnet-name}" `
185+
-SubnetId "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/<subnet-name>" `
186186
-PrivateLinkServiceConnection `
187187
(New-AzPrivateLinkServiceConnection -Name "myConnection" `
188-
-PrivateLinkServiceId "/subscriptions/{subscription}/resourceGroups/{rg}/providers/Microsoft.KeyVault/vaults/{key-vault-name}" `
188+
-PrivateLinkServiceId "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>" `
189189
-GroupId "vault")
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

193193
```powershell
194-
Add-AzKeyVaultNetworkRule -VaultName {key-vault-name} `
195-
-ResourceGroupName myResourceGroup `
196-
-IPAddress {trusted-ip-address}/32
194+
Add-AzKeyVaultNetworkRule -VaultName "<vault-name>" `
195+
-ResourceGroupName "<resource-group>" `
196+
-IPAddress "<trusted-ip-address>/32"
197197
```
198198

199199
---
@@ -215,9 +215,9 @@ You can use the Azure Identity and Azure Key Vault Secrets client library to man
215215
from azure.keyvault.secrets import SecretClient
216216
from azure.identity import DefaultAzureCredential
217217

218-
key_vault_name = "<your-key-vault-name>"
218+
key_vault_name = "<vault-name>"
219219
KVUri = f"https://{key_vault_name}.vault.azure.net"
220-
secret_name = "<your-secret-name>"
220+
secret_name = "<secret-name>"
221221

222222
credential = DefaultAzureCredential()
223223
client = SecretClient(vault_url=KVUri, credential=credential)

articles/key-vault/general/assign-access-policy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.custom: devx-track-azurecli, has-azure-ad-ps-ref, sfi-image-nochange
88
ms.service: azure-key-vault
99
ms.subservice: general
1010
ms.topic: how-to
11-
ms.date: 04/15/2025
11+
ms.date: 03/26/2026
1212
ms.author: mbaldwin
1313
#Customer intent: As someone new to Key Vault, I'm trying to learn basic concepts that can help me understand Key Vault documentation.
1414
---
@@ -128,13 +128,13 @@ Determine the object ID of the application, group, or user to which you want to
128128
- Applications and other service principals: use the [Get-AzADServicePrincipal](/powershell/module/az.resources/get-azadserviceprincipal) cmdlet with the `-SearchString` parameter to filter results to the name of the desired service principal:
129129
130130
```azurepowershell-interactive
131-
Get-AzADServicePrincipal -SearchString <search-string>
131+
Get-AzADServicePrincipal -SearchString "<search-string>"
132132
```
133133
134134
- Groups: use the [Get-AzADGroup](/powershell/module/az.resources/get-azadgroup) cmdlet with the `-SearchString` parameter to filter results to the name of the desired group:
135135
136136
```azurepowershell-interactive
137-
Get-AzADGroup -SearchString <search-string>
137+
Get-AzADGroup -SearchString "<search-string>"
138138
```
139139
140140
In the output, the object ID is listed as `Id`.
@@ -152,7 +152,7 @@ Determine the object ID of the application, group, or user to which you want to
152152
Use the [Set-AzKeyVaultAccessPolicy](/powershell/module/az.keyvault/set-azkeyvaultaccesspolicy) cmdlet to assign the access policy:
153153
154154
```azurepowershell-interactive
155-
Set-AzKeyVaultAccessPolicy -VaultName <key-vault-name> -ObjectId <Id> -PermissionsToSecrets <secrets-permissions> -PermissionsToKeys <keys-permissions> -PermissionsToCertificates <certificate-permissions
155+
Set-AzKeyVaultAccessPolicy -VaultName "<vault-name>" -ObjectId "<object-id>" -PermissionsToSecrets <secrets-permissions> -PermissionsToKeys <keys-permissions> -PermissionsToCertificates <certificate-permissions>
156156
```
157157

158158
You need only include `-PermissionsToSecrets`, `-PermissionsToKeys`, and `-PermissionsToCertificates` when assigning permissions to those particular types. The allowable values for `<secret-permissions>`, `<key-permissions>`, and `<certificate-permissions>` are given in the [Set-AzKeyVaultAccessPolicy - Parameters](/powershell/module/az.keyvault/set-azkeyvaultaccesspolicy#parameters) documentation.

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

Lines changed: 10 additions & 10 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: 04/16/2025
10+
ms.date: 03/26/2026
1111
ms.author: mbaldwin
1212

1313
---
@@ -18,8 +18,8 @@ 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
22-
|**Managed HSM** |<ul><li>HSM-protected keys</li></ul> | https://{hsm-name}.managedhsm.azure.net
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`
22+
|**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
2525

@@ -43,16 +43,16 @@ For clients that cannot support specific HTTP verbs, Azure Key Vault allows usin
4343

4444
To work with objects in the Azure Key Vault, the following are example URLs:
4545

46-
- To CREATE a key called TESTKEY in a Key Vault use - `PUT /keys/TESTKEY?api-version=<api_version> HTTP/1.1`
46+
- To CREATE a key called TESTKEY in a Key Vault use - `PUT /keys/TESTKEY?api-version=<api-version> HTTP/1.1`
4747

48-
- To IMPORT a key called IMPORTEDKEY into a Key Vault use - `POST /keys/IMPORTEDKEY/import?api-version=<api_version> HTTP/1.1`
48+
- To IMPORT a key called IMPORTEDKEY into a Key Vault use - `POST /keys/IMPORTEDKEY/import?api-version=<api-version> HTTP/1.1`
4949

50-
- To GET a secret called MYSECRET in a Key Vault use - `GET /secrets/MYSECRET?api-version=<api_version> HTTP/1.1`
50+
- To GET a secret called MYSECRET in a Key Vault use - `GET /secrets/MYSECRET?api-version=<api-version> HTTP/1.1`
5151

52-
- To SIGN a digest using a key called TESTKEY in a Key Vault use - `POST /keys/TESTKEY/sign?api-version=<api_version> HTTP/1.1`
52+
- To SIGN a digest using a key called TESTKEY in a Key Vault use - `POST /keys/TESTKEY/sign?api-version=<api-version> HTTP/1.1`
5353

5454
- The authority for a request to a Key Vault is always as follows,
55-
- For vaults: `https://{keyvault-name}.vault.azure.net/`
55+
- For vaults: `https://<vault-name>.vault.azure.net/`
5656
- For Managed HSMs: `https://{HSM-name}.managedhsm.azure.net/`
5757
Keys are always stored under the /keys path, while Secrets are always stored under the /secrets path.
5858

@@ -115,8 +115,8 @@ For more information on registering your application and authenticating to use A
115115
Access tokens must be sent to the service using the HTTP Authorization header:
116116

117117
```
118-
PUT /keys/MYKEY?api-version=<api_version> HTTP/1.1
119-
Authorization: Bearer <access_token>
118+
PUT /keys/MYKEY?api-version=<api-version> HTTP/1.1
119+
Authorization: Bearer <access-token>
120120
121121
```
122122

0 commit comments

Comments
 (0)