KmsEncryptionProfile Class

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models

Assembly:: Az.RedHatOpenShiftHcp.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Configure etcd encryption Key Management Service (KMS) key. Your Microsoft Entra application used to create the cluster must be authorized to access this keyvault, e.g using the AzureCLI: az keyvault set-policy -n $KEYVAULT_NAME --key-permissions decrypt encrypt --spn (YOUR APPLICATION CLIENT ID)

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.KmsEncryptionProfileTypeConverter))]
public class KmsEncryptionProfile : Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IKmsEncryptionProfile

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.KmsEncryptionProfileTypeConverter))>]
type KmsEncryptionProfile = class
    interface IKmsEncryptionProfile
    interface IJsonSerializable

Public Class KmsEncryptionProfile
Implements IKmsEncryptionProfile

Inheritance: Object
KmsEncryptionProfile

Attributes: TypeConverterAttribute

Implements: IKmsEncryptionProfile IJsonSerializable

Constructors

Name	Description
KmsEncryptionProfile()	Creates an new KmsEncryptionProfile instance.

Properties

Name	Description
ActiveKeyName	name is the name of the keyvault key used for encryption/decryption.
ActiveKeyVersion	version contains the version of the key to use.
KeyVaultType	The type of keyvault used for KMS encryption. Defaults to KeyVault when absent.
VaultName	vaultName is the name of the keyvault that contains the secret.
Visibility	visibility of the keyvault that contains the secret.

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of KmsEncryptionProfile.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of KmsEncryptionProfile.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models.IKmsEncryptionProfile.
FromJsonString(String)	Creates a new instance of KmsEncryptionProfile, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of KmsEncryptionProfile into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()

Applies to