Skip to content

Commit 89cf711

Browse files
author
Jack Williams
authored
Update key-vault-linux.md
Clarity. Any field that says "optional" is assumed to be optional. Updating the docs to be precise about what scenario it is optional and when its required. Also stating the outcome if failing to provide the field when in a scenario its required.
1 parent 17b581e commit 89cf711

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

articles/virtual-machines/extensions/key-vault-linux.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ The following JSON shows the schema for the Key Vault VM extension. The extensio
100100
"observedCertificates": <list of KeyVault URIs representing monitored certificates, e.g.: ["https://myvault.vault.azure.net/secrets/mycertificate", "https://myvault.vault.azure.net/secrets/mycertificate2"]>
101101
},
102102
"authenticationSettings": {
103-
"msiEndpoint": <Optional MSI endpoint e.g.: "http://169.254.169.254/metadata/identity">,
104-
"msiClientId": <Optional MSI identity e.g.: "c7373ae5-91c2-4165-8ab6-7381d6e75619">
103+
"msiEndpoint": <Required when msiClientId is provided. MSI endpoint e.g. for most Azure VMs: "http://169.254.169.254/metadata/identity">,
104+
"msiClientId": <Required when VM has any user assigned identities. MSI identity e.g.: "c7373ae5-91c2-4165-8ab6-7381d6e75619".>
105105
}
106106
}
107107
}
@@ -114,7 +114,7 @@ The following JSON shows the schema for the Key Vault VM extension. The extensio
114114
> This is because the `/secrets` path returns the full certificate, including the private key, while the `/certificates` path does not. More information about certificates can be found here: [Key Vault Certificates](../../key-vault/general/about-keys-secrets-certificates.md)
115115
116116
> [!IMPORTANT]
117-
> The 'authenticationSettings' property is **required** for VMs with **user assigned identities**.
117+
> The 'authenticationSettings' property is **required** for VMs with any **user assigned identities**. Even if you want to use a system assigned identity this is still required otherwise the VM extension will not know which identity to use. Without this section, a VM with user assigned identities will result in the Key Vault extension failing and being unable to download certificates.
118118
> Set msiClientId to the identity that will authenticate to Key Vault.
119119
>
120120
> Also **required** for **Azure Arc-enabled VMs**.

0 commit comments

Comments
 (0)