AzureKeyVaultKms Class

Package:

com.azure.resourcemanager.containerservice.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-containerservice:2.64.0

• java.lang.Object
• • com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms

Implements

JsonSerializable<AzureKeyVaultKms>

public final class AzureKeyVaultKms
implements JsonSerializable<AzureKeyVaultKms>

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

Constructor Summary

Constructor	Description
AzureKeyVaultKms()	Creates an instance of AzureKeyVaultKms class.

Method Summary

Modifier and Type	Method and Description
Boolean	enabled() Get the enabled property: Whether to enable Azure Key Vault key management service.
static AzureKeyVaultKms	fromJson(JsonReader jsonReader) Reads an instance of AzureKeyVaultKms from the JsonReader.
String	keyId() Get the keyId property: The identifier of the Azure Key Vault key.
KeyVaultNetworkAccessTypes	keyVaultNetworkAccess() Get the keyVaultNetworkAccess property: Network access of the key vault.
String	keyVaultResourceId() Get the keyVaultResourceId property: Resource ID of key vault.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
AzureKeyVaultKms	withEnabled(Boolean enabled) Set the enabled property: Whether to enable Azure Key Vault key management service.
AzureKeyVaultKms	withKeyId(String keyId) Set the keyId property: The identifier of the Azure Key Vault key.
AzureKeyVaultKms	withKeyVaultNetworkAccess(KeyVaultNetworkAccessTypes keyVaultNetworkAccess) Set the keyVaultNetworkAccess property: Network access of the key vault.
AzureKeyVaultKms	withKeyVaultResourceId(String keyVaultResourceId) Set the keyVaultResourceId property: Resource ID of key vault.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureKeyVaultKms

public AzureKeyVaultKms()

Creates an instance of AzureKeyVaultKms class.

Method Details

enabled

public Boolean enabled()

Get the enabled property: Whether to enable Azure Key Vault key management service. The default is false.

Returns:

the enabled value.

fromJson

public static AzureKeyVaultKms fromJson(JsonReader jsonReader)

Reads an instance of AzureKeyVaultKms from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureKeyVaultKms if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the AzureKeyVaultKms.

keyId

public String keyId()

Get the keyId property: The identifier of the Azure Key Vault key. For more information, see [Azure Key Vault key identifiers](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates\#vault-name-and-object-name). 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](https://learn.microsoft.com/en-us/azure/aks/kms-data-encryption-concepts).

Returns:

the keyId value.

keyVaultNetworkAccess

public KeyVaultNetworkAccessTypes keyVaultNetworkAccess()

Get the keyVaultNetworkAccess property: 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`.

Returns:

the keyVaultNetworkAccess value.

keyVaultResourceId

public String keyVaultResourceId()

Get the keyVaultResourceId property: 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.

Returns:

the keyVaultResourceId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withEnabled

public AzureKeyVaultKms withEnabled(Boolean enabled)

Set the enabled property: Whether to enable Azure Key Vault key management service. The default is false.

Parameters:

enabled - the enabled value to set.

Returns:

the AzureKeyVaultKms object itself.

withKeyId

public AzureKeyVaultKms withKeyId(String keyId)

Set the keyId property: The identifier of the Azure Key Vault key. For more information, see [Azure Key Vault key identifiers](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates\#vault-name-and-object-name). 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](https://learn.microsoft.com/en-us/azure/aks/kms-data-encryption-concepts).

Parameters:

keyId - the keyId value to set.

Returns:

the AzureKeyVaultKms object itself.

withKeyVaultNetworkAccess

public AzureKeyVaultKms withKeyVaultNetworkAccess(KeyVaultNetworkAccessTypes keyVaultNetworkAccess)

Set the keyVaultNetworkAccess property: 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`.

Parameters:

keyVaultNetworkAccess - the keyVaultNetworkAccess value to set.

Returns:

the AzureKeyVaultKms object itself.

withKeyVaultResourceId

public AzureKeyVaultKms withKeyVaultResourceId(String keyVaultResourceId)

Set the keyVaultResourceId property: 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.

Parameters:

keyVaultResourceId - the keyVaultResourceId value to set.

Returns:

the AzureKeyVaultKms object itself.