Skip to content

Commit 3f56707

Browse files
prmerger-automator[bot]prmerger-automator[bot]
authored
Merge pull request #2662 from msmbaldwin/placeholder-standardization-includes
Standardize placeholders in key-vault/includes
2 parents 4b05de1 + 8815106 commit 3f56707

16 files changed

Lines changed: 62 additions & 62 deletions

‎articles/key-vault/includes/key-management-policy-grammar.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
author: msmbaldwin
33
ms.service: azure-key-vault
44
ms.topic: include
5-
ms.date: 04/14/2025
5+
ms.date: 03/26/2026
66

77
ms.author: mbaldwin
88
---
@@ -72,8 +72,8 @@ A Claim Condition is a JSON object that identifies a claim name, a condition for
7272

7373
```json
7474
{
75-
"claim": "<claim name>",
76-
"equals": <value to match>
75+
"claim": "<claim-name>",
76+
"equals": <value-to-match>
7777
}
7878
```
7979

@@ -84,7 +84,7 @@ Claim names allow "dot notation" to enable JSON object navigation, for example:
8484
```json
8585
{
8686
"claim": "object.object.claim",
87-
"equals": <value to match>
87+
"equals": <value-to-match>
8888
}
8989
```
9090

@@ -101,12 +101,12 @@ Examples are shown below. In the first, allOf requires all conditions to be met:
101101
"allOf":
102102
[
103103
{
104-
"claim": "<claim_1>",
105-
"equals": <value_1>
104+
"claim": "<claim-1>",
105+
"equals": <value-1>
106106
},
107107
{
108-
"claim": "<claim_2>",
109-
"equals": <value_2>
108+
"claim": "<claim-2>",
109+
"equals": <value-2>
110110
}
111111
]
112112
}
@@ -121,12 +121,12 @@ In this example, anyOf requires that any condition match:
121121
"anyOf":
122122
[
123123
{
124-
"claim": "<claim_1>",
125-
"equals": <value_1>
124+
"claim": "<claim-1>",
125+
"equals": <value-1>
126126
},
127127
{
128-
"claim": "<claim_2>",
129-
"equals": <value_2>
128+
"claim": "<claim-2>",
129+
"equals": <value-2>
130130
}
131131
]
132132
}
@@ -140,19 +140,19 @@ The anyOf and allOf condition objects may be nested:
140140
"allOf":
141141
[
142142
{
143-
"claim": "<claim_1>",
144-
"equals": <value_1>
143+
"claim": "<claim-1>",
144+
"equals": <value-1>
145145
},
146146
{
147147
"anyOf":
148148
[
149149
{
150-
"claim": "<claim_2>",
151-
"equals": <value_2>
150+
"claim": "<claim-2>",
151+
"equals": <value-2>
152152
},
153153
{
154-
"claim": "<claim_3>",
155-
"equals": <value_3>
154+
"claim": "<claim-3>",
155+
"equals": <value-3>
156156
}
157157
]
158158
}
@@ -166,26 +166,26 @@ Or:
166166
"allOf":
167167
[
168168
{
169-
"claim": "<claim_1>",
170-
"equals": <value_1>
169+
"claim": "<claim-1>",
170+
"equals": <value-1>
171171
},
172172
{
173173
"anyOf":
174174
[
175175
{
176-
"claim": "<claim_2>",
177-
"equals": <value_2>
176+
"claim": "<claim-2>",
177+
"equals": <value-2>
178178
},
179179
{
180180
"allOf":
181181
[
182182
{
183-
"claim": "<claim_3>",
184-
"equals": <value_3>
183+
"claim": "<claim-3>",
184+
"equals": <value-3>
185185
},
186186
{
187-
"claim": "<claim_4>",
188-
"equals": <value_4>
187+
"claim": "<claim-4>",
188+
"equals": <value-4>
189189
}
190190
]
191191
}
@@ -205,8 +205,8 @@ Conditions are collected into Authority statements and combined:
205205
"allOf":
206206
[
207207
{
208-
"claim": "<claim_1>",
209-
"equals": <value_1>
208+
"claim": "<claim-1>",
209+
"equals": <value-1>
210210
}
211211
]
212212
}
@@ -248,7 +248,7 @@ The encoding is as follows:
248248
```json
249249
{
250250
"contentType": "application/json; charset=utf-8",
251-
"data": "<BASE64URL(JSON serialization of policy)>"
251+
"data": "<base64url-encoded-policy>"
252252
}
253253
```
254254

‎articles/key-vault/includes/key-vault-create-secret.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ To add a secret to your newly created key vault, use the following command:
1313

1414
# [Azure CLI](#tab/azure-cli)
1515
```azurecli
16-
az keyvault secret set --vault-name "<your-unique-keyvault-name>" --name "mySecret" --value "Success!"
16+
az keyvault secret set --vault-name "<vault-name>" --name "mySecret" --value "Success!"
1717
```
1818
# [Azure PowerShell](#tab/azurepowershell)
1919

2020
```azurepowershell
2121
$secret = ConvertTo-SecureString -String 'Success!' -AsPlainText
22-
Set-AzKeyVaultSecret -VaultName <your-unique-keyvault-name> -Name mySecret -SecretValue $secret
22+
Set-AzKeyVaultSecret -VaultName "<vault-name>" -Name "mySecret" -SecretValue $secret
2323
```
2424
---

‎articles/key-vault/includes/key-vault-python-qs-rg-kv-creation.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,35 @@ ms.author: msmbaldwin
1414
1. Use the `az group create` command to create a resource group:
1515

1616
```azurecli
17-
az group create --name myResourceGroup --location eastus
17+
az group create --name <resource-group> --location eastus
1818
```
1919
2020
You can change "eastus" to a location nearer to you, if you prefer.
2121
2222
1. Use `az keyvault create` to create the key vault:
2323
2424
```azurecli
25-
az keyvault create --name <your-unique-keyvault-name> --resource-group myResourceGroup --enable-rbac-authorization true --enable-purge-protection true
25+
az keyvault create --name <vault-name> --resource-group <resource-group> --enable-rbac-authorization true --enable-purge-protection true
2626
```
2727
28-
Replace `<your-unique-keyvault-name>` with a name that's unique across all of Azure. You typically use your personal or company name along with other numbers and identifiers.
28+
Replace `<vault-name>` with a name that's unique across all of Azure. You typically use your personal or company name along with other numbers and identifiers.
2929
3030
# [Azure PowerShell](#tab/azure-powershell)
3131
3232
1. Use the `New-AzResourceGroup` command to create a resource group:
3333
3434
```azurepowershell
35-
New-AzResourceGroup -Name myResourceGroup -Location eastus
35+
New-AzResourceGroup -Name "<resource-group>" -Location "eastus"
3636
```
3737
3838
You can change "eastus" to a location nearer to you, if you prefer.
3939
4040
1. Use `New-AzKeyVault` to create the key vault:
4141
4242
```azurepowershell
43-
New-AzKeyVault -Name <your-unique-keyvault-name> -ResourceGroupName myResourceGroup -Location eastus -EnableRbacAuthorization $true -EnablePurgeProtection
43+
New-AzKeyVault -Name "<vault-name>" -ResourceGroupName "<resource-group>" -Location "eastus" -EnableRbacAuthorization $true -EnablePurgeProtection
4444
```
4545
46-
Replace `<your-unique-keyvault-name>` with a name that's unique across all of Azure. You typically use your personal or company name along with other numbers and identifiers.
46+
Replace `<vault-name>` with a name that's unique across all of Azure. You typically use your personal or company name along with other numbers and identifiers.
4747
4848
---

‎articles/key-vault/includes/key-vault-set-environmental-variables.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ ms.author: msmbaldwin
1111
Our script will use the value assigned to the `KEY_VAULT_NAME` environment variable as the name of the key vault. You must therefore set this value using the following command:
1212

1313
```console
14-
export KEY_VAULT_NAME=<your-unique-keyvault-name>
14+
export KEY_VAULT_NAME=<vault-name>
1515
````

‎articles/key-vault/includes/rbac/upn-certificate-officer-cli.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: msmbaldwin
1313
To gain permissions to your key vault through [Role-Based Access Control (RBAC)](/azure/key-vault/general/rbac-guide), assign a role to your "User Principal Name" (UPN) using the Azure CLI command [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create).
1414

1515
```azurecli
16-
az role assignment create --role "Key Vault Certificates Officer" --assignee "<upn>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"
16+
az role assignment create --role "Key Vault Certificates Officer" --assignee "<upn>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>"
1717
```
1818

19-
Replace \<upn\>, \<subscription-id\>, \<resource-group-name\> and \<your-unique-keyvault-name\> with your actual values. Your UPN will typically be in the format of an email address (e.g., [email protected]).
19+
Replace `<upn>`, `<subscription-id>`, `<resource-group>`, and `<vault-name>` with your actual values. Your UPN is typically in the format of an email address (for example, [email protected]).

‎articles/key-vault/includes/rbac/upn-certificate-officer-powershell.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: msmbaldwin
1313
To gain permissions to your key vault through [Role-Based Access Control (RBAC)](/azure/key-vault/general/rbac-guide), assign a role to your "User Principal Name" (UPN) using the Azure PowerShell cmdlet [New-AzRoleAssignment](/powershell/module/az.resources/new-azroleassignment).
1414

1515
```azurepowershell
16-
New-AzRoleAssignment -SignInName "<upn>" -RoleDefinitionName "Key Vault Certificates Officer" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"
16+
New-AzRoleAssignment -SignInName "<upn>" -RoleDefinitionName "Key Vault Certificates Officer" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>"
1717
```
1818

19-
Replace \<upn\>, \<subscription-id\>, \<resource-group-name\> and \<your-unique-keyvault-name\> with your actual values. Your UPN will typically be in the format of an email address (e.g., [email protected]).
19+
Replace `<upn>`, `<subscription-id>`, `<resource-group>`, and `<vault-name>` with your actual values. Your UPN is typically in the format of an email address (for example, [email protected]).

‎articles/key-vault/includes/rbac/upn-certificate-user-cli.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: msmbaldwin
1313
To gain permissions to your key vault through [Role-Based Access Control (RBAC)](/azure/key-vault/general/rbac-guide), assign a role to your "User Principal Name" (UPN) using the Azure CLI command [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create).
1414

1515
```azurecli
16-
az role assignment create --role "Key Vault Certificate User" --assignee "<upn>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"
16+
az role assignment create --role "Key Vault Certificate User" --assignee "<upn>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>"
1717
```
1818

19-
Replace \<upn\>, \<subscription-id\>, \<resource-group-name\> and \<your-unique-keyvault-name\> with your actual values. Your UPN will typically be in the format of an email address (e.g., [email protected]).
19+
Replace `<upn>`, `<subscription-id>`, `<resource-group>`, and `<vault-name>` with your actual values. Your UPN is typically in the format of an email address (for example, [email protected]).

‎articles/key-vault/includes/rbac/upn-certificate-user-powershell.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: msmbaldwin
1313
To gain permissions to your key vault through [Role-Based Access Control (RBAC)](/azure/key-vault/general/rbac-guide), assign a role to your "User Principal Name" (UPN) using the Azure PowerShell cmdlet [New-AzRoleAssignment](/powershell/module/az.resources/new-azroleassignment).
1414

1515
```azurepowershell
16-
New-AzRoleAssignment -SignInName "<upn>" -RoleDefinitionName "Key Vault Certificate User" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"
16+
New-AzRoleAssignment -SignInName "<upn>" -RoleDefinitionName "Key Vault Certificate User" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>"
1717
```
1818

19-
Replace \<upn\>, \<subscription-id\>, \<resource-group-name\> and \<your-unique-keyvault-name\> with your actual values. Your UPN will typically be in the format of an email address (e.g., [email protected]).
19+
Replace `<upn>`, `<subscription-id>`, `<resource-group>`, and `<vault-name>` with your actual values. Your UPN is typically in the format of an email address (for example, [email protected]).

‎articles/key-vault/includes/rbac/upn-crypto-officer-cli.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: msmbaldwin
1313
To gain permissions to your key vault through [Role-Based Access Control (RBAC)](/azure/key-vault/general/rbac-guide), assign a role to your "User Principal Name" (UPN) using the Azure CLI command [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create).
1414

1515
```azurecli
16-
az role assignment create --role "Key Vault Crypto Officer" --assignee "<upn>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"
16+
az role assignment create --role "Key Vault Crypto Officer" --assignee "<upn>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>"
1717
```
1818

19-
Replace \<upn\>, \<subscription-id\>, \<resource-group-name\> and \<your-unique-keyvault-name\> with your actual values. Your UPN will typically be in the format of an email address (e.g., [email protected]).
19+
Replace `<upn>`, `<subscription-id>`, `<resource-group>`, and `<vault-name>` with your actual values. Your UPN is typically in the format of an email address (for example, [email protected]).

‎articles/key-vault/includes/rbac/upn-crypto-officer-powershell.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: msmbaldwin
1313
To gain permissions to your key vault through [Role-Based Access Control (RBAC)](/azure/key-vault/general/rbac-guide), assign a role to your "User Principal Name" (UPN) using the Azure PowerShell cmdlet [New-AzRoleAssignment](/powershell/module/az.resources/new-azroleassignment).
1414

1515
```azurepowershell
16-
New-AzRoleAssignment -SignInName "<upn>" -RoleDefinitionName "Key Vault Crypto Officer" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"
16+
New-AzRoleAssignment -SignInName "<upn>" -RoleDefinitionName "Key Vault Crypto Officer" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>"
1717
```
1818

19-
Replace \<upn\>, \<subscription-id\>, \<resource-group-name\> and \<your-unique-keyvault-name\> with your actual values. Your UPN will typically be in the format of an email address (e.g., [email protected]).
19+
Replace `<upn>`, `<subscription-id>`, `<resource-group>`, and `<vault-name>` with your actual values. Your UPN is typically in the format of an email address (for example, [email protected]).

0 commit comments

Comments
 (0)