Google Cloud Key Management Service v1 API - Class KeyHandle (3.15.0)

public sealed class KeyHandle : IMessage<KeyHandle>, IEquatable<KeyHandle>, IDeepCloneable<KeyHandle>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class KeyHandle.

Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a [CryptoKey][google.cloud.kms.v1.CryptoKey].

Inheritance

object > KeyHandle

Implements

IMessage KeyHandle, IEquatable KeyHandle, IDeepCloneable KeyHandle, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

KeyHandle()

public KeyHandle()

KeyHandle(KeyHandle)

public KeyHandle(KeyHandle other)

Parameter
Name	Description
`other`	`KeyHandle`

Properties

KeyHandleName

public KeyHandleName KeyHandleName { get; set; }

KeyHandleName-typed view over the Name resource name property.

Property Value
Type	Description
`KeyHandleName`

KmsKey

public string KmsKey { get; set; }

Output only. Name of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that has been provisioned for Customer Managed Encryption Key (CMEK) use in the [KeyHandle][google.cloud.kms.v1.KeyHandle] project and location for the requested resource type. The [CryptoKey][google.cloud.kms.v1.CryptoKey] project will reflect the value configured in the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] on the resource project's ancestor folder at the time of the [KeyHandle][google.cloud.kms.v1.KeyHandle] creation. If more than one ancestor folder has a configured [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig], the nearest of these configurations is used.

Property Value
Type	Description
`string`

KmsKeyAsCryptoKeyName

public CryptoKeyName KmsKeyAsCryptoKeyName { get; set; }

CryptoKeyName-typed view over the KmsKey resource name property.

Property Value
Type	Description
`CryptoKeyName`

Name

public string Name { get; set; }

Identifier. Name of the [KeyHandle][google.cloud.kms.v1.KeyHandle] resource, e.g. projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}.

Property Value
Type	Description
`string`

ResourceTypeSelector

public string ResourceTypeSelector { get; set; }

Required. Indicates the resource type that the resulting [CryptoKey][google.cloud.kms.v1.CryptoKey] is meant to protect, e.g. {SERVICE}.googleapis.com/{TYPE}. See documentation for supported resource types.

Property Value
Type	Description
`string`