Skip to content

Commit 9b48a8b

Browse files
Merge pull request #2660 from msmbaldwin/placeholder-standardization-certificates
Standardize placeholders in key-vault/certificates
2 parents 3634879 + 01bd90f commit 9b48a8b

13 files changed

Lines changed: 74 additions & 74 deletions

articles/key-vault/certificates/create-certificate-scenarios.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: certificates
99
ms.topic: how-to
10-
ms.date: 01/30/2026
10+
ms.date: 03/26/2026
1111

1212
ms.author: mbaldwin
1313

@@ -96,7 +96,7 @@ StatusCode: 200, ReasonPhrase: 'OK'
9696
{
9797
"id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
9898
"issuer": {
99-
"name": "{issuer-name}"
99+
"name": "mydigicert"
100100
},
101101
"csr": "MIICq......DD5Lp5cqXg==",
102102
"cancellation_requested": false,
@@ -128,7 +128,7 @@ StatusCode: 200, ReasonPhrase: 'OK'
128128
{
129129
"id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
130130
"issuer": {
131-
"name": "{issuer-name}"
131+
"name": "mydigicert"
132132
},
133133
"csr": "MIICq......DD5Lp5cqXg==",
134134
"cancellation_requested": false,
@@ -160,16 +160,16 @@ StatusCode: 200, ReasonPhrase: 'OK'
160160
{
161161
"id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
162162
"issuer": {
163-
"name": "{issuer-name}"
163+
"name": "mydigicert"
164164
},
165165
"csr": "MIICq......DD5Lp5cqXg==",
166166
"cancellation_requested": false,
167167
"status": "failed",
168168
"status_details": "",
169169
"request_id": "a76827a18b63421c917da80f28e9913d",
170170
"error": {
171-
"code": "<errorcode>",
172-
"message": "<message>"
171+
"code": "Certificate issuer error",
172+
"message": "The issuer encountered an error processing the certificate request."
173173
}
174174
}
175175
@@ -310,7 +310,7 @@ StatusCode: 200, ReasonPhrase: 'OK'
310310
{
311311
"id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
312312
"issuer": {
313-
"name": "{issuer-name}"
313+
"name": "mydigicert"
314314
},
315315
"csr": "MIICq......DD5Lp5cqXg==",
316316
"cancellation_requested": true,
@@ -343,7 +343,7 @@ StatusCode: 200, ReasonPhrase: 'OK'
343343
{
344344
"id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
345345
"issuer": {
346-
"name": "{issuer-name}"
346+
"name": "mydigicert"
347347
},
348348
"csr": "MIICq......DD5Lp5cqXg==",
349349
"cancellation_requested": false,
@@ -410,7 +410,7 @@ Location: “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api
410410

411411
|Element name|Required|Type|Version|Description|
412412
|------------------|--------------|----------|-------------|-----------------|
413-
|x5c|Yes|array|\<introducing version>|X509 certificate chain as base 64 string array.|
413+
|x5c|Yes|array|\<introducing-version>|X509 certificate chain as base 64 string array.|
414414

415415
### Response
416416

articles/key-vault/certificates/create-certificate-signing-request.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Follow these steps to add a certificate from CAs that aren't partnered with Key
4141
1. Select the **Generate/Import** tab.
4242
1. On the **Create a certificate** screen, choose the following values:
4343
- **Method of Certificate Creation**: Generate.
44-
- **Certificate Name**: ContosoManualCSRCertificate.
44+
- **Certificate Name**: A unique name for your certificate.
4545
- **Type of Certificate Authority (CA)**: Certificate issued by a non-integrated CA.
4646
- **Subject**: `"CN=www.contosoHRApp.com"`.
4747
> [!NOTE]
@@ -81,7 +81,7 @@ The certificate request has now been successfully merged.
8181
1. Create the CSR.
8282

8383
```azure-powershell
84-
$csr = Add-AzKeyVaultCertificate -VaultName ContosoKV -Name ContosoManualCSRCertificate -CertificatePolicy $policy
84+
$csr = Add-AzKeyVaultCertificate -VaultName "<vault-name>" -Name "<certificate-name>" -CertificatePolicy $policy
8585
$csr.CertificateSigningRequest
8686
```
8787

@@ -90,7 +90,7 @@ The certificate request has now been successfully merged.
9090
1. Merge the signed request in Key Vault. After the certificate request has been signed, you can merge it with the initial private/public key pair created in Azure Key Vault.
9191

9292
```azure-powershell-interactive
93-
Import-AzKeyVaultCertificate -VaultName ContosoKV -Name ContosoManualCSRCertificate -FilePath C:\test\OutputCertificateFile.cer
93+
Import-AzKeyVaultCertificate -VaultName "<vault-name>" -Name "<certificate-name>" -FilePath C:\test\OutputCertificateFile.cer
9494
```
9595
9696
The certificate request has now been successfully merged.

articles/key-vault/certificates/how-to-export-certificate.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.service: azure-key-vault
99
ms.subservice: certificates
1010
ms.topic: how-to
1111
ms.custom: mvc, sfi-image-nochange
12-
ms.date: 01/30/2026
12+
ms.date: 03/26/2026
1313

1414
ms.author: mbaldwin
1515
#Customer intent: As a security admin who is new to Azure, I want to use Key Vault to securely store certificates in Azure.
@@ -77,12 +77,12 @@ For more information, see [parameter definitions](/cli/azure/keyvault/secret#az-
7777

7878
# [PowerShell](#tab/azure-powershell)
7979

80-
Use this command in Azure PowerShell to get the certificate named **TestCert01** from the key vault named **ContosoKV01**. To download the certificate as a PFX file, run following command. These commands access **SecretId**, and then save the content as a PFX file.
80+
Use this command in Azure PowerShell to get a certificate from your key vault. To download the certificate as a PFX file, run the following command. These commands access **SecretId**, and then save the content as a PFX file.
8181

8282
```azurepowershell
83-
$vaultName = '<YourVault>'
84-
$certificateName = '<YourCert>'
85-
$password = '<YourPwd>'
83+
$vaultName = '<vault-name>'
84+
$certificateName = '<certificate-name>'
85+
$password = '<password>'
8686
8787
$pfxSecret = Get-AzKeyVaultSecret -VaultName $vaultName -Name $certificateName -AsPlainText
8888
$certBytes = [Convert]::FromBase64String($pfxSecret)

articles/key-vault/certificates/how-to-integrate-certificate-authority.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -111,17 +111,17 @@ You can use Azure PowerShell to create and manage Azure resources by using comma
111111
1. Create an Azure resource group by using [New-AzResourceGroup](/powershell/module/az.resources/new-azresourcegroup). A resource group is a logical container into which Azure resources are deployed and managed.
112112

113113
```azurepowershell-interactive
114-
New-AzResourceGroup -Name ContosoResourceGroup -Location EastUS
114+
New-AzResourceGroup -Name "<resource-group>" -Location "<location>"
115115
```
116116
117-
2. Create a key vault that has a unique name. Here, `Contoso-Vaultname` is the name for the key vault.
117+
2. Create a key vault that has a unique name.
118118
119-
- **Vault name**: `Contoso-Vaultname`
120-
- **Resource group name**: `ContosoResourceGroup`
121-
- **Location**: `EastUS`
119+
- **Vault name**: A unique name for your vault
120+
- **Resource group name**: The resource group from step 1
121+
- **Location**: Your preferred location
122122
123123
```azurepowershell-interactive
124-
New-AzKeyVault -Name 'Contoso-Vaultname' -ResourceGroupName 'ContosoResourceGroup' -Location 'EastUS' -EnableRbacAuthorization $true
124+
New-AzKeyVault -Name "<vault-name>" -ResourceGroupName "<resource-group>" -Location "<location>" -EnableRbacAuthorization $true
125125
```
126126

127127
3. Define variables for the following values from your DigiCert CertCentral account:
@@ -138,14 +138,14 @@ You can use Azure PowerShell to create and manage Azure resources by using comma
138138

139139
4. Set the issuer. Doing so will add Digicert as a certificate authority in the key vault. [Learn more about the parameters.](/powershell/module/az.keyvault/Set-AzKeyVaultCertificateIssuer)
140140
```azurepowershell-interactive
141-
Set-AzKeyVaultCertificateIssuer -VaultName "Contoso-Vaultname" -Name "TestIssuer01" -IssuerProvider DigiCert -AccountId $accountId -ApiKey $secureApiKey -OrganizationDetails $org -PassThru
141+
Set-AzKeyVaultCertificateIssuer -VaultName "<vault-name>" -Name "TestIssuer01" -IssuerProvider DigiCert -AccountId $accountId -ApiKey $secureApiKey -OrganizationDetails $org -PassThru
142142
```
143143

144144
5. Set the policy for the certificate and issuing certificate from DigiCert directly in Key Vault:
145145

146146
```azurepowershell-interactive
147-
$Policy = New-AzKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "TestIssuer01" -ValidityInMonths 12 -RenewAtNumberOfDaysBeforeExpiry 60
148-
Add-AzKeyVaultCertificate -VaultName "Contoso-Vaultname" -Name "ExampleCertificate" -CertificatePolicy $Policy
147+
$Policy = New-AzKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=<domain-name>" -IssuerName "TestIssuer01" -ValidityInMonths 12 -RenewAtNumberOfDaysBeforeExpiry 60
148+
Add-AzKeyVaultCertificate -VaultName "<vault-name>" -Name "ExampleCertificate" -CertificatePolicy $Policy
149149
```
150150

151151
The certificate is now issued by DigiCert certificate authority in the specified key vault.

articles/key-vault/certificates/overview-renew-certificate.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: msmbaldwin
77
ms.service: azure-key-vault
88
ms.subservice: certificates
99
ms.topic: overview
10-
ms.date: 04/14/2025
10+
ms.date: 03/26/2026
1111

1212
ms.author: mbaldwin
1313
---
@@ -61,7 +61,7 @@ To renew a nonintegrated CA certificate:
6161
1. On the certificate pane, select **New Version**.
6262
3. On the **Create a certificate** page, make sure the **Generate** option is selected under **Method of Certificate Creation**.
6363
4. Verify the **Subject** and other details about the certificate and then select **Create**.
64-
5. You should now see the message **The creation of certificate << certificate name >> is currently pending. Click here to go its Certificate Operation to monitor the progress**
64+
5. You should now see the message **The creation of certificate `<certificate-name>` is currently pending. Click here to go its Certificate Operation to monitor the progress**
6565
1. Select on the message and a new pane should be shown. The pane should show the status as "In Progress". At this point, Key Vault has generated a CSR that you can download using the **Download CSR** option.
6666
1. Select **Download CSR** to download a CSR file to your local drive.
6767
1. Send the CSR to your choice of CA to sign the request.
@@ -73,29 +73,29 @@ To renew a nonintegrated CA certificate:
7373
Use the Azure CLI [az keyvault certificate create](/cli/azure/keyvault/certificate#az-keyvault-certificate-create) command, providing the name of the certificate you wish to renew:
7474

7575
```azurecli-interactive
76-
az keyvault certificate create --vault-name "<your-unique-keyvault-name>" -n "<name-of-certificate-to-renew>" -p "$(az keyvault certificate get-default-policy)"
76+
az keyvault certificate create --vault-name "<vault-name>" -n "<certificate-name>" -p "$(az keyvault certificate get-default-policy)"
7777
```
7878

7979
After renewing the certificate, you can view all the versions of the certificate using the Azure CLI [az keyvault certificate list-versions](/cli/azure/keyvault/certificate#az-keyvault-certificate-list) command:
8080

8181
```azurecli-interactive
82-
az keyvault certificate list-versions --vault-name "<your-unique-keyvault-name>" -n "<name-of-renewed-certificate>"
82+
az keyvault certificate list-versions --vault-name "<vault-name>" -n "<certificate-name>"
8383
```
8484

8585
# [Azure PowerShell](#tab/azure-powershell)
8686

8787
Use the Azure PowerShell [New-AzKeyVaultCertificatePolicy](/powershell/module/az.keyvault/new-azkeyvaultcertificatepolicy) cmdlet, providing the name of the certificate you wish to renew:
8888

8989
```azurepowershell-interactive
90-
$Policy = New-AzKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal
90+
$Policy = New-AzKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=<domain-name>" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal
9191
92-
Add-AzKeyVaultCertificate -VaultName "<your-unique-keyvault-name>" -Name "<name-of-certificate-to-renew>" -CertificatePolicy $Policy
92+
Add-AzKeyVaultCertificate -VaultName "<vault-name>" -Name "<certificate-name>" -CertificatePolicy $Policy
9393
```
9494

9595
After renewing the certificate, you can view all the versions of the certificate using the Azure PowerShell [Get-AzKeyVaultCertificate](/cli/azure/keyvault/certificate#az-keyvault-certificate-list) cmdlet:
9696

9797
```azurepowershell-interactive
98-
Get-AzKeyVaultCertificate "<your-unique-keyvault-name>" -Name "<name-of-renewed-certificate>" -IncludeVersions
98+
Get-AzKeyVaultCertificate "<vault-name>" -Name "<certificate-name>" -IncludeVersions
9999
```
100100

101101
---

articles/key-vault/certificates/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: certificates
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,16 +40,16 @@ To add a certificate to the vault, you just need to take a couple of additional
4040
Type the commands below to create a self-signed certificate with default policy called **ExampleCertificate** :
4141

4242
```azurecli
43-
az keyvault certificate create --vault-name "<your-unique-keyvault-name>" -n ExampleCertificate -p "$(az keyvault certificate get-default-policy)"
43+
az keyvault certificate create --vault-name "<vault-name>" -n ExampleCertificate -p "$(az keyvault certificate get-default-policy)"
4444
```
4545

46-
You can now reference this certificate that you added to Azure Key Vault by using its URI. Use **`https://<your-unique-keyvault-name>.vault.azure.net/certificates/ExampleCertificate`** to get the current version.
46+
You can now reference this certificate that you added to Azure Key Vault by using its URI. Use **`https://<vault-name>.vault.azure.net/certificates/ExampleCertificate`** to get the current version.
4747

4848
To view previously stored certificate:
4949

5050
```azurecli
5151
52-
az keyvault certificate show --name "ExampleCertificate" --vault-name "<your-unique-keyvault-name>"
52+
az keyvault certificate show --name "ExampleCertificate" --vault-name "<vault-name>"
5353
```
5454

5555
Now, you have created a Key Vault, stored a certificate, and retrieved it.

articles/key-vault/certificates/quick-create-go.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Quickstart – Azure Key Vault Go client library - Manage certificates
33
description: Learn how to create, retrieve, and delete certificates from an Azure key vault using the Go client library
44
author: Duffney
55
ms.author: jduffney
6-
ms.date: 01/30/2026
6+
ms.date: 03/26/2026
77
ms.service: azure-key-vault
88
ms.subservice: certificates
99
ms.topic: quickstart
@@ -191,13 +191,13 @@ Before you run the code, create an environment variable named `KEY_VAULT_NAME`.
191191
# [Bash](#tab/bash)
192192

193193
```bash
194-
export KEY_VAULT_NAME=<YourKeyVaultName>
194+
export KEY_VAULT_NAME=<vault-name>
195195
```
196196

197197
# [PowerShell](#tab/powershell)
198198

199199
```powershell
200-
$env:KEY_VAULT_NAME=<YourKeyVaultName>
200+
$env:KEY_VAULT_NAME=<vault-name>
201201
```
202202

203203
---
@@ -217,7 +217,7 @@ For more examples, see the [module documentation](https://aka.ms/azsdk/go/keyvau
217217
Run the following command to delete the resource group and all its remaining resources:
218218

219219
```azurecli
220-
az group delete --resource-group myResourceGroup
220+
az group delete --resource-group <resource-group>
221221
```
222222

223223
## Next steps

articles/key-vault/certificates/quick-create-java.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn about the Azure Key Vault Certificate client library for Java
44
author: msmbaldwin
55
ms.custom: devx-track-java, devx-track-azurecli, devx-track-azurepowershell, mode-api, passwordless-java, devx-track-extended-java
66
ms.author: mbaldwin
7-
ms.date: 01/30/2026
7+
ms.date: 03/26/2026
88

99
ms.service: azure-key-vault
1010
ms.subservice: certificates
@@ -129,19 +129,19 @@ This application is using your key vault name as an environment variable called
129129
Windows
130130

131131
```cmd
132-
set KEY_VAULT_NAME=<your-key-vault-name>
132+
set KEY_VAULT_NAME=<vault-name>
133133
````
134134
135135
Windows PowerShell
136136
137137
```powershell
138-
$Env:KEY_VAULT_NAME="<your-key-vault-name>"
138+
$Env:KEY_VAULT_NAME="<vault-name>"
139139
```
140140

141141
macOS or Linux
142142

143143
```cmd
144-
export KEY_VAULT_NAME=<your-key-vault-name>
144+
export KEY_VAULT_NAME=<vault-name>
145145
```
146146

147147
## Object model
@@ -175,7 +175,7 @@ Application requests to most Azure services must be authorized. Using the [Defau
175175

176176
In this quickstart, `DefaultAzureCredential` authenticates to key vault using the credentials of the local development user logged into the Azure CLI. When the application is deployed to Azure, the same `DefaultAzureCredential` code can automatically discover and use a managed identity that is assigned to an App Service, Virtual Machine, or other services. For more information, see [Managed Identity Overview](/entra/identity/managed-identities-azure-resources/overview).
177177

178-
In this example, the name of your key vault is expanded to the key vault URI, in the format `https://<your-key-vault-name>.vault.azure.net`. For more information about authenticating to key vault, see [Developer's Guide](/azure/key-vault/general/developers-guide#authenticate-to-key-vault-in-code).
178+
In this example, the name of your key vault is expanded to the key vault URI, in the format `https://<vault-name>.vault.azure.net`. For more information about authenticating to key vault, see [Developer's Guide](/azure/key-vault/general/developers-guide#authenticate-to-key-vault-in-code).
179179

180180
```java
181181
String keyVaultName = System.getenv("KEY_VAULT_NAME");
@@ -229,11 +229,11 @@ deletionPoller.waitForCompletion();
229229
When no longer needed, you can use the Azure CLI or Azure PowerShell to remove your key vault and the corresponding resource group.
230230

231231
```azurecli
232-
az group delete -g "myResourceGroup"
232+
az group delete -g "<resource-group>"
233233
```
234234

235235
```azurepowershell
236-
Remove-AzResourceGroup -Name "myResourceGroup"
236+
Remove-AzResourceGroup -Name "<resource-group>"
237237
```
238238

239239
## Sample code

articles/key-vault/certificates/quick-create-net.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Quickstart - Azure Key Vault certificates client library for .NET
33
description: Learn how to create, retrieve, and delete certificates from an Azure key vault using the .NET client library
44
author: msmbaldwin
55
ms.author: mbaldwin
6-
ms.date: 01/30/2026
6+
ms.date: 03/26/2026
77

88
ms.service: azure-key-vault
99
ms.subservice: certificates
@@ -98,16 +98,16 @@ The application obtains the key vault name from an environment variable called `
9898

9999
Windows
100100
```cmd
101-
set KEY_VAULT_NAME=<your-key-vault-name>
101+
set KEY_VAULT_NAME=<vault-name>
102102
````
103103
Windows PowerShell
104104
```powershell
105-
$Env:KEY_VAULT_NAME="<your-key-vault-name>"
105+
$Env:KEY_VAULT_NAME="<vault-name>"
106106
```
107107

108108
macOS or Linux
109109
```bash
110-
export KEY_VAULT_NAME=<your-key-vault-name>
110+
export KEY_VAULT_NAME=<vault-name>
111111
```
112112

113113
## Object model
@@ -132,7 +132,7 @@ Application requests to most Azure services must be authorized. Using the [Defau
132132

133133
In this quickstart, `DefaultAzureCredential` authenticates to key vault using the credentials of the local development user logged into the Azure CLI. When the application is deployed to Azure, the same `DefaultAzureCredential` code can automatically discover and use a managed identity that is assigned to an App Service, Virtual Machine, or other services. For more information, see [Managed Identity Overview](/entra/identity/managed-identities-azure-resources/overview).
134134

135-
In this example, the name of your key vault is expanded to the key vault URI, in the format `https://<your-key-vault-name>.vault.azure.net`. For more information about authenticating to key vault, see [Developer's Guide](/azure/key-vault/general/developers-guide#authenticate-to-key-vault-in-code).
135+
In this example, the name of your key vault is expanded to the key vault URI, in the format `https://<vault-name>.vault.azure.net`. For more information about authenticating to key vault, see [Developer's Guide](/azure/key-vault/general/developers-guide#authenticate-to-key-vault-in-code).
136136

137137
```csharp
138138
string keyVaultName = Environment.GetEnvironmentVariable("KEY_VAULT_NAME");

0 commit comments

Comments
 (0)