Reference
Azure Key Vault
Move secrets to and from a Key Vault name prefix.
Move secrets to and from a Key Vault name prefix.
Connection
| What | This provider |
|---|---|
| Vendor | Microsoft Azure |
| Key | azure-key-vault |
| Availability | available. You can connect it today. |
| Credential we hold | azure-service-principal |
| Values read back | yes |
| Activation | immediate |
Directions
| Direction | What it does |
|---|---|
import | We read names and values out of the store into your environment. |
export | We write names and values from your environment into the store. |
Activation
immediate. The running app sees a new value at once.
Conflict policies
| Direction | Policies you can pick |
|---|---|
import | skip_existing, new_version, fail |
export | create_only, overwrite, overwrite_and_prune |
How syncs work says what each one does.
Connect
Paste a credential from the vendor. We seal it and never show it again.
| Field | Label | Kind | Required | What it is |
|---|---|---|---|---|
tenantId | Directory (tenant) ID | secret; we mask it here and seal it | yes | |
clientId | Application (client) ID | secret; we mask it here and seal it | yes | |
clientSecret | Client secret | secret; we mask it here and seal it | yes |
Connection fields
You set these when you connect. Every mapping on the connection shares them.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
vaultName | Vault | text | yes | no | The vault's name alone, without the URL around it. One connection covers one vault. |
basePrefix | Base prefix | text | yes | no | The widest secret name prefix this connection may touch. Every sync scope will sit under it. |
Mapping fields
You answer these once per environment you map.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
namePrefix | Secret name prefix | text | yes | no | Maps onto this environment. Underscores become -U, so DATABASE_URL is DATABASE-UURL. |
Required permissions
We probe for these when we verify the connection.
| Permission | Directions | Blocking | Without it |
|---|---|---|---|
Microsoft.KeyVault/vaults/secrets/readMetadata/action | every direction | yes | Preview cannot list what is under this prefix. |
Microsoft.KeyVault/vaults/secrets/getSecret/action | import | yes | Import cannot read any value. |
Microsoft.KeyVault/vaults/secrets/setSecret/action | export | yes | Export cannot write anything. |
Microsoft.KeyVault/vaults/secrets/deleteSecret/action | export | no | The overwrite_and_prune policy cannot remove remote keys. |
Microsoft.KeyVault/vaults/secrets/recover/action | export | no | A key pruned inside the vault's retention window cannot be written again. |