Share via

AzureKeyVaultKms interface

  • Reference
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

Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.
keyVaultNetworkAccess

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

Identifier of Azure Key Vault key. See key identifier format for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty.

keyId?: string

Property Value

string

keyVaultNetworkAccess

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