AzureKeyVaultKms interface

Package:: @azure/arm-containerservice

Azure Key Vault key management service settings for the security profile.

Properties

enabled	Whether to enable Azure Key Vault key management service. The default is false.
keyId	The identifier of the Azure Key Vault key. For more information, see Azure Key Vault key identifiers. This property is required when Azure Key Vault key management service is enabled and must be omitted when the service is disabled. Starting with API versions 2026-07-01 and 2026-07-02-preview, a versioned key identifier uses the legacy KMS experience, while an unversioned key identifier uses the new KMS experience. For more information, see KMS data encryption concepts.
keyVaultNetworkAccess	Network access of the key vault. Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`.
keyVaultResourceId	Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty.

Property Details

enabled

Whether to enable Azure Key Vault key management service. The default is false.

enabled?: boolean

Property Value

boolean

keyId

The identifier of the Azure Key Vault key. For more information, see Azure Key Vault key identifiers. This property is required when Azure Key Vault key management service is enabled and must be omitted when the service is disabled. Starting with API versions 2026-07-01 and 2026-07-02-preview, a versioned key identifier uses the legacy KMS experience, while an unversioned key identifier uses the new KMS experience. For more information, see KMS data encryption concepts.

keyId?: string

Property Value

string

keyVaultNetworkAccess

Network access of the key vault. Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link. The default value is Public.

keyVaultNetworkAccess?: string

Property Value

string

keyVaultResourceId

Resource ID of key vault. When keyVaultNetworkAccess is Private, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is Public, leave the field empty.

keyVaultResourceId?: string

Property Value

string