Skip to content

Commit 651c214

Browse files
committed
NLB-7335: Add guidance for using the Azure Key Vault Secret Identifiers
1 parent 3d8c70e commit 651c214

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

content/nginxaas-azure/getting-started/ssl-tls-certificates/ssl-tls-certificates-azure-cli.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ az nginx deployment certificate create --certificate-name
4343
--key-vault-secret-id keyVaultSecretId
4444
```
4545

46+
{{< call-out "important" >}}
47+
The `--key-vault-secret-id` must be the **Secret Identifier**, not the Certificate Identifier.
48+
To find the Secret Identifier, see [Finding the Azure Key Vault Secret Identifier]({{< ref "/nginxaas-azure/getting-started/ssl-tls-certificates/ssl-tls-certificates-portal/#finding-the-azure-key-vault-secret-identifier" >}}).
49+
{{< /call-out >}}
50+
4651
See [Azure CLI Certificate Create Documentation](https://learn.microsoft.com/en-us/cli/azure/nginx/deployment/certificate#az-nginx-deployment-certificate-create) for more details on the available parameters.
4752

4853
## Update a certificate

content/nginxaas-azure/getting-started/ssl-tls-certificates/ssl-tls-certificates-portal.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,36 @@ You can manage SSL/TSL certificates for F5 NGINXaaS for Azure (NGINXaaS) using t
1616

1717
{{< include "/nginxaas-azure/ssl-tls-prerequisites.md" >}}
1818

19+
## Finding the Azure Key Vault Secret Identifier {#finding-the-azure-key-vault-secret-identifier}
20+
21+
When adding a certificate using the Azure CLI, Terraform, or ARM/Bicep templates, you need to provide the **Secret Identifier** from Azure Key Vault.
22+
23+
{{< call-out "important" >}}
24+
**Use the Secret Identifier, not the Certificate Identifier.**
25+
26+
When you create a certificate in Azure Key Vault, it creates three related objects:
27+
28+
- A **Certificate** (with a Certificate Identifier)
29+
- A **Key** (for cryptographic operations)
30+
- A **Secret** (containing the certificate and private key as a PFX bundle)
31+
32+
NGINXaaS requires the **Secret Identifier** to access the certificate and its private key.
33+
{{< /call-out >}}
34+
35+
To find the Secret Identifier:
36+
37+
1. Go to your Azure Key Vault in the Azure portal.
38+
2. Select **Certificates** from the left menu.
39+
3. Select the certificate you want to use.
40+
4. Select the current version of the certificate.
41+
5. Copy the **Secret Identifier** value (not the Certificate Identifier).
42+
43+
The Secret Identifier format is:
44+
45+
```text
46+
https://{vault-name}.vault.azure.net/secrets/{certificate-name}
47+
```
48+
1949
### Adding an SSL/TLS certificate
2050

2151
Before you begin, refer Azure documentation to [Import a certificate to your Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/certificates/tutorial-import-certificate?tabs=azure-portal#import-a-certificate-to-your-key-vault).

0 commit comments

Comments
 (0)