Skip to content

Commit a7eb0df

Browse files
committed
Standardize placeholders in key-vault/secrets
- Convert non-standard placeholders to lowercase kebab-case - Fix curly-brace and camelCase placeholder formats - Update ms.date for modified files Part of placeholder standardization series.
1 parent 3634879 commit a7eb0df

13 files changed

Lines changed: 78 additions & 78 deletions

articles/key-vault/secrets/javascript-developer-guide-get-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: azure-key-vault
77
ms.subservice: secrets
88
ms.topic: how-to
99
ms.custom: devx-track-js, devx-track-azurecli
10-
ms.date: 01/30/2026
10+
ms.date: 03/26/2026
1111

1212
ms.author: mbaldwin
1313
#Customer intent: As a JavaScript developer who is new to Azure, I want to know the high level steps necessary to use Key Vault secrets in JavaScript.
@@ -102,7 +102,7 @@ import { SecretClient } from '@azure/keyvault-secrets';
102102
const credential = new DefaultAzureCredential();
103103
104104
// Create SecretClient
105-
const vaultName = '<your-vault-name>';
105+
const vaultName = '<vault-name>';
106106
const url = `https://${vaultName}.vault.azure.net`;
107107
const client = new SecretClient(url, credential);
108108

articles/key-vault/secrets/multiline-secrets.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: azure-key-vault
77
ms.subservice: secrets
88
ms.topic: quickstart
99
ms.custom: mvc, devx-track-azurecli, devx-track-azurepowershell, mode-other
10-
ms.date: 04/14/2025
10+
ms.date: 03/26/2026
1111

1212
ms.author: mbaldwin
1313
#Customer intent: As a security admin who is new to Azure, I want to use Key Vault to securely store keys and passwords in Azure
@@ -31,12 +31,12 @@ secret
3131
You can then pass this file to the Azure CLI [az keyvault secret set](/cli/azure/keyvault/secret#az-keyvault-secret-set) command using the `--file` parameter.
3232

3333
```azurecli-interactive
34-
az keyvault secret set --vault-name "<your-unique-keyvault-name>" --name "MultilineSecret" --file "secretfile.txt"
34+
az keyvault secret set --vault-name "<vault-name>" --name "MultilineSecret" --file "secretfile.txt"
3535
```
3636
You can then view the stored secret using the Azure CLI [az keyvault secret show](/cli/azure/keyvault/secret#az-keyvault-secret-show) command.
3737

3838
```azurecli-interactive
39-
az keyvault secret show --name "MultilineSecret" --vault-name "<your-unique-keyvault-name>" --query "value"
39+
az keyvault secret show --name "MultilineSecret" --vault-name "<vault-name>" --query "value"
4040
```
4141

4242
The secret will be returned with `\n` in place of newline:
@@ -59,13 +59,13 @@ $SecureSecret = ConvertTo-SecureString -String $RawSecret -AsPlainText -Force
5959
Lastly, you store the secret using the [Set-AzKeyVaultSecret](/powershell/module/az.keyvault/set-azkeyvaultsecret) cmdlet.
6060

6161
```azurepowershell-interactive
62-
$secret = Set-AzKeyVaultSecret -VaultName "<your-unique-keyvault-name>" -Name "MultilineSecret" -SecretValue $SecureSecret
62+
$secret = Set-AzKeyVaultSecret -VaultName "<vault-name>" -Name "MultilineSecret" -SecretValue $SecureSecret
6363
```
6464

6565
You can then view the stored secret using the Azure CLI [az keyvault secret show](/cli/azure/keyvault/secret#az-keyvault-secret-show) command or the Azure PowerShell [Get-AzKeyVaultSecret](/powershell/module/az.keyvault/get-azkeyvaultsecret) cmdlet.
6666

6767
```azurecli-interactive
68-
az keyvault secret show --name "MultilineSecret" --vault-name "<your-unique-keyvault-name>" --query "value"
68+
az keyvault secret show --name "MultilineSecret" --vault-name "<vault-name>" --query "value"
6969
```
7070

7171
The secret will be returned with `\n` in place of newline:

articles/key-vault/secrets/overview-storage-keys-powershell.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.service: azure-key-vault
66
ms.subservice: secrets
77
author: msmbaldwin
88
ms.author: mbaldwin
9-
ms.date: 01/30/2026
9+
ms.date: 03/26/2026
1010

1111
ms.custom: devx-track-azurepowershell
1212

@@ -71,7 +71,7 @@ Connect-AzAccount
7171
If you have multiple Azure subscriptions, you can list them using the [Get-AzSubscription](/powershell/module/az.accounts/get-azsubscription) cmdlet, and specify the subscription you wish to use with the [Set-AzContext](/powershell/module/az.accounts/set-azcontext) cmdlet.
7272

7373
```azurepowershell-interactive
74-
Set-AzContext -SubscriptionId <subscriptionId>
74+
Set-AzContext -SubscriptionId <subscription-id>
7575
```
7676

7777
### Set variables
@@ -81,9 +81,9 @@ First, set the variables to be used by the PowerShell cmdlets in the following s
8181
We'll also use the Azure PowerShell [Get-AzContext](/powershell/module/az.accounts/get-azcontext) and [Get-AzStorageAccount](/powershell/module/az.storage/get-azstorageaccount) cmdlets to get your user ID and the context of your Azure storage account.
8282

8383
```azurepowershell-interactive
84-
$resourceGroupName = <YourResourceGroupName>
85-
$storageAccountName = <YourStorageAccountName>
86-
$keyVaultName = <YourKeyVaultName>
84+
$resourceGroupName = <resource-group>
85+
$storageAccountName = <storage-account-name>
86+
$keyVaultName = <vault-name>
8787
$keyVaultSpAppId = "cfa8b339-82a2-471a-a3c9-0fc0be7a4093"
8888
$storageAccountKey = "key1" #(key1 or key2 are allowed)
8989
@@ -132,7 +132,7 @@ Use the Azure PowerShell [New-AzRoleAssignment](/powershell/module/az.resources/
132132
```azurepowershell-interactive
133133
# Give your user principal access to all storage account permissions, on your Key Vault instance
134134
135-
New-AzRoleAssignment -SignInName $userId -RoleDefinitionName "Key Vault Secrets Officer" -Scope "/subscriptions/{subscriptionID}/resourceGroups/{resource-group}/providers/Microsoft.KeyVault/vaults/$keyVaultName"
135+
New-AzRoleAssignment -SignInName $userId -RoleDefinitionName "Key Vault Secrets Officer" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/$keyVaultName"
136136
```
137137

138138
The permissions for storage accounts aren't available on the storage account "Access policies" page in the Azure portal.
@@ -201,11 +201,11 @@ The commands in this section complete the following actions:
201201

202202
### Set variables
203203

204-
First, set the variables to be used by the PowerShell cmdlets in the following steps. Be sure to update the \<YourStorageAccountName\> and \<YourKeyVaultName\> placeholders.
204+
First, set the variables to be used by the PowerShell cmdlets in the following steps. Be sure to update the `<storage-account-name>` and `<vault-name>` placeholders.
205205

206206
```azurepowershell-interactive
207-
$storageAccountName = <YourStorageAccountName>
208-
$keyVaultName = <YourKeyVaultName>
207+
$storageAccountName = <storage-account-name>
208+
$keyVaultName = <vault-name>
209209
```
210210

211211
### Define a shared access signature definition template
@@ -237,7 +237,7 @@ For more information about account SAS, see:
237237
Use the Azure PowerShell [Set-AzKeyVaultManagedStorageSasDefinition](/powershell/module/az.keyvault/set-azkeyvaultmanagedstoragesasdefinition) cmdlet to create a shared access signature definition. You can provide the name of your choice to the `-Name` parameter.
238238

239239
```azurepowershell-interactive
240-
Set-AzKeyVaultManagedStorageSasDefinition -AccountName $storageAccountName -VaultName $keyVaultName -Name <YourSASDefinitionName> -TemplateUri $sasTemplate -SasType 'account' -ValidityPeriod ([System.Timespan]::FromDays(1))
240+
Set-AzKeyVaultManagedStorageSasDefinition -AccountName $storageAccountName -VaultName $keyVaultName -Name <sas-definition-name> -TemplateUri $sasTemplate -SasType 'account' -ValidityPeriod ([System.Timespan]::FromDays(1))
241241
```
242242

243243
### Verify the shared access signature definition
@@ -247,14 +247,14 @@ You can verify that the shared access signature definition has been stored in yo
247247
First, find the shared access signature definition in your key vault.
248248

249249
```azurepowershell-interactive
250-
Get-AzKeyVaultSecret -VaultName <YourKeyVaultName>
250+
Get-AzKeyVaultSecret -VaultName <vault-name>
251251
```
252252

253253
The secret corresponding to your SAS definition will have these properties:
254254

255255
```console
256-
Vault Name : <YourKeyVaultName>
257-
Name : <SecretName>
256+
Vault Name : <vault-name>
257+
Name : <secret-name>
258258
...
259259
Content Type : application/vnd.ms-sastoken-storage
260260
Tags :
@@ -263,7 +263,7 @@ Tags :
263263
You can now use the [Get-AzKeyVaultSecret](/powershell/module/az.keyvault/get-azkeyvaultsecret) cmdlet with the `VaultName` and `Name` parameters to view the contents of that secret.
264264

265265
```azurepowershell-interactive
266-
$secretValueText = Get-AzKeyVaultSecret -VaultName <YourKeyVaultName> -Name <SecretName> -AsPlainText
266+
$secretValueText = Get-AzKeyVaultSecret -VaultName <vault-name> -Name <secret-name> -AsPlainText
267267
Write-Output $secretValueText
268268
```
269269

articles/key-vault/secrets/overview-storage-keys.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: azure-key-vault
77
ms.subservice: secrets
88
author: msmbaldwin
99
ms.author: mbaldwin
10-
ms.date: 01/30/2026
10+
ms.date: 03/26/2026
1111

1212
ms.custom: devx-track-azurecli
1313
# Customer intent: As a developer, I want to use Azure Key Vault and Azure CLI for secure management of my storage credentials and shared access signature tokens.
@@ -75,10 +75,10 @@ Use the Azure CLI [az role assignment create](/cli/azure/role/assignment) comman
7575

7676
- `--role`: Pass the "Storage Account Key Operator Service Role" Azure role. This role limits the access scope to your storage account. For a classic storage account, pass "Classic Storage Account Key Operator Service Role" instead.
7777
- `--assignee`: Pass the value "https://vault.azure.net", which is the url for Key Vault in the Azure public cloud. (For Azure Government cloud use '--assignee-object-id' instead, see [Service principal application ID](#service-principal-application-id).)
78-
- `--scope`: Pass your storage account resource ID, which is in the form `/subscriptions/<subscriptionID>/resourceGroups/<StorageAccountResourceGroupName>/providers/Microsoft.Storage/storageAccounts/<YourStorageAccountName>`. Find your subscription ID, by using the Azure CLI [az account list](/cli/azure/account?#az-account-list) command. Find your storage account name and storage account resource group, by using the Azure CLI [az storage account list](/cli/azure/storage/account?#az-storage-account-list) command.
78+
- `--scope`: Pass your storage account resource ID, which is in the form `/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account-name>`. Find your subscription ID, by using the Azure CLI [az account list](/cli/azure/account?#az-account-list) command. Find your storage account name and storage account resource group, by using the Azure CLI [az storage account list](/cli/azure/storage/account?#az-storage-account-list) command.
7979

8080
```azurecli-interactive
81-
az role assignment create --role "Storage Account Key Operator Service Role" --assignee "https://vault.azure.net" --scope "/subscriptions/<subscriptionID>/resourceGroups/<StorageAccountResourceGroupName>/providers/Microsoft.Storage/storageAccounts/<YourStorageAccountName>"
81+
az role assignment create --role "Storage Account Key Operator Service Role" --assignee "https://vault.azure.net" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account-name>"
8282
```
8383
### Give your user account permission to managed storage accounts
8484

@@ -87,7 +87,7 @@ Use the Azure CLI [az role assignment create](/cli/azure/role/assignment#az-role
8787
```azurecli-interactive
8888
# Give your user principal access to all storage account permissions, on your Key Vault instance
8989
90-
az role assignment create --role "Key Vault Secrets Officer" --assignee [email protected] --scope /subscriptions/{subscriptionID}/resourceGroups/{resource-group}/providers/Microsoft.KeyVault/vaults/<YourKeyVaultName>
90+
az role assignment create --role "Key Vault Secrets Officer" --assignee [email protected] --scope /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.KeyVault/vaults/<vault-name>
9191
```
9292

9393
Permissions for storage accounts aren't available on the storage account "Access policies" page in the Azure portal.
@@ -98,10 +98,10 @@ Create a Key Vault managed storage account using the Azure CLI [az keyvault stor
9898

9999
- `--vault-name`: Pass the name of your key vault. To find the name of your key vault, use the Azure CLI [az keyvault list](/cli/azure/keyvault?#az-keyvault-list) command.
100100
- `-n`: Pass the name of your storage account. To find the name of your storage account, use the Azure CLI [az storage account list](/cli/azure/storage/account?#az-storage-account-list) command.
101-
- `--resource-id`: Pass your storage account resource ID, which is in the form `/subscriptions/<subscriptionID>/resourceGroups/<StorageAccountResourceGroupName>/providers/Microsoft.Storage/storageAccounts/<YourStorageAccountName>`. Find your subscription ID, by using the Azure CLI [az account list](/cli/azure/account?#az-account-list) command. Find your storage account name and storage account resource group, by using the Azure CLI [az storage account list](/cli/azure/storage/account?#az-storage-account-list) command.
101+
- `--resource-id`: Pass your storage account resource ID, which is in the form `/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account-name>`. Find your subscription ID, by using the Azure CLI [az account list](/cli/azure/account?#az-account-list) command. Find your storage account name and storage account resource group, by using the Azure CLI [az storage account list](/cli/azure/storage/account?#az-storage-account-list) command.
102102

103103
```azurecli-interactive
104-
az keyvault storage add --vault-name <YourKeyVaultName> -n <YourStorageAccountName> --active-key-name key1 --auto-regenerate-key --regeneration-period P30D --resource-id "/subscriptions/<subscriptionID>/resourceGroups/<StorageAccountResourceGroupName>/providers/Microsoft.Storage/storageAccounts/<YourStorageAccountName>"
104+
az keyvault storage add --vault-name <vault-name> -n <storage-account-name> --active-key-name key1 --auto-regenerate-key --regeneration-period P30D --resource-id "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account-name>"
105105
```
106106

107107
## Shared access signature tokens
@@ -110,7 +110,7 @@ You can also ask Key Vault to generate shared access signature tokens. A shared
110110

111111
The commands in this section complete the following actions:
112112

113-
- Set an account shared access signature definition `<YourSASDefinitionName>`. The definition is set on a Key Vault managed storage account `<YourStorageAccountName>` in your key vault `<YourKeyVaultName>`.
113+
- Set an account shared access signature definition `<sas-definition-name>`. The definition is set on a Key Vault managed storage account `<storage-account-name>` in your key vault `<vault-name>`.
114114
- Set a Key Vault managed storage shared access signature definition in the vault. The definition has the template URI of the shared access signature token that was created. The definition has the shared access signature type `account` and is valid for N days.
115115
- Verify that the shared access signature was saved in your key vault as a secret.
116116

@@ -146,7 +146,7 @@ For more information about account SAS, see:
146146
Use the Azure CLI [az keyvault storage sas-definition create](/powershell/module/az.keyvault/set-azkeyvaultmanagedstoragesasdefinition) command, passing the SAS definition template from the previous step to the `--template-uri` parameter, to create a shared access signature definition. You can provide the name of your choice to the `-n` parameter.
147147

148148
```azurecli-interactive
149-
az keyvault storage sas-definition create --vault-name <YourKeyVaultName> --account-name <YourStorageAccountName> -n <YourSASDefinitionName> --validity-period P2D --sas-type account --template-uri <sasDefinitionTemplate>
149+
az keyvault storage sas-definition create --vault-name <vault-name> --account-name <storage-account-name> -n <sas-definition-name> --validity-period P2D --sas-type account --template-uri <sas-definition-template>
150150
```
151151

152152
### Verify the shared access signature definition
@@ -156,7 +156,7 @@ You can verify that the shared access signature definition has been stored in yo
156156
You can now use the [az keyvault storage sas-definition show](/azure/key-vault/secrets/overview-storage-keys) command and the `id` property to view the content of that secret.
157157

158158
```azurecli-interactive
159-
az keyvault storage sas-definition show --id https://<YourKeyVaultName>.vault.azure.net/storage/<YourStorageAccountName>/sas/<YourSASDefinitionName>
159+
az keyvault storage sas-definition show --id https://<vault-name>.vault.azure.net/storage/<storage-account-name>/sas/<sas-definition-name>
160160
```
161161

162162
## Next steps

articles/key-vault/secrets/quick-create-bicep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Two Azure resources are defined in the Bicep file:
7979
---
8080
8181
> [!NOTE]
82-
> Replace **\<vault-name\>** with the name of the key vault. Replace **\<object-id\>** with the object ID of a user, service principal, or security group in the Microsoft Entra tenant for the vault. The object ID must be unique for the list of access policies. Get it by using Get-AzADUser or Get-AzADServicePrincipal cmdlets.
82+
> Replace **`<vault-name>`** with the name of the key vault. Replace **`<object-id>`** with the object ID of a user, service principal, or security group in the Microsoft Entra tenant for the vault. The object ID must be unique for the list of access policies. Get it by using Get-AzADUser or Get-AzADServicePrincipal cmdlets.
8383
8484
When the deployment finishes, you should see a message indicating the deployment succeeded.
8585

articles/key-vault/secrets/quick-create-cli.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.service: azure-key-vault
66
ms.subservice: secrets
77
ms.topic: quickstart
88
ms.custom: mvc, devx-track-azurecli, mode-api
9-
ms.date: 01/30/2026
9+
ms.date: 03/26/2026
1010

1111
ms.author: mbaldwin
1212
#Customer intent: As a security admin who is new to Azure, I want to use Key Vault to securely store keys and passwords in Azure
@@ -40,17 +40,17 @@ To add a secret to the vault, you just need to take a couple of additional steps
4040
Use the Azure CLI [az keyvault secret set](/cli/azure/keyvault/secret#az-keyvault-secret-set) command below to create a secret in Key Vault called **ExamplePassword** that will store the value **hVFkk965BuUv** :
4141

4242
```azurecli
43-
az keyvault secret set --vault-name "<your-unique-keyvault-name>" --name "ExamplePassword" --value "hVFkk965BuUv"
43+
az keyvault secret set --vault-name "<vault-name>" --name "ExamplePassword" --value "hVFkk965BuUv"
4444
```
4545

4646
## Retrieve a secret from Key Vault
4747

48-
You can now reference this password that you added to Azure Key Vault by using its URI. Use **`https://<your-unique-keyvault-name>.vault.azure.net/secrets/ExamplePassword`** to get the current version.
48+
You can now reference this password that you added to Azure Key Vault by using its URI. Use **`https://<vault-name>.vault.azure.net/secrets/ExamplePassword`** to get the current version.
4949

5050
To view the value contained in the secret as plain text, use the Azure CLI [az keyvault secret show](/cli/azure/keyvault/secret#az-keyvault-secret-show) command:
5151

5252
```azurecli
53-
az keyvault secret show --name "ExamplePassword" --vault-name "<your-unique-keyvault-name>" --query "value"
53+
az keyvault secret show --name "ExamplePassword" --vault-name "<vault-name>" --query "value"
5454
```
5555

5656
Now, you have created a Key Vault, stored a secret, and retrieved it.

0 commit comments

Comments
 (0)