KeyVaultProperties interface
Properties of the key vault.
Properties
| federated |
The application (client) ID of the multi-tenant Microsoft Entra application. Used for cross-tenant customer-managed key scenarios where the encryption key is stored in a different tenant than the cluster. The application must be configured with the user-assigned managed identity as a federated identity credential. |
| key |
The name of the key vault key. |
| key |
The Uri of the key vault. |
| key |
The version of the key vault key. |
| user |
The user assigned identity (ARM resource id) that has access to the key. The identity must have 'Get', 'Wrap Key', and 'Unwrap Key' permissions on the Key Vault key, or be assigned the 'Key Vault Crypto Service Encryption User' role. |
Property Details
federatedIdentityClientId
The application (client) ID of the multi-tenant Microsoft Entra application. Used for cross-tenant customer-managed key scenarios where the encryption key is stored in a different tenant than the cluster. The application must be configured with the user-assigned managed identity as a federated identity credential.
federatedIdentityClientId?: string
Property Value
string
keyName
The name of the key vault key.
keyName?: string
Property Value
string
keyVaultUri
The Uri of the key vault.
keyVaultUri?: string
Property Value
string
keyVersion
The version of the key vault key.
keyVersion?: string
Property Value
string
userIdentity
The user assigned identity (ARM resource id) that has access to the key. The identity must have 'Get', 'Wrap Key', and 'Unwrap Key' permissions on the Key Vault key, or be assigned the 'Key Vault Crypto Service Encryption User' role.
userIdentity?: string
Property Value
string