Class CryptoKeyVersion

A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.

Inheritance
object
CryptoKeyVersion
Implements
Inherited Members
Namespace: Google.Apis.CloudKMS.v1.Data
Assembly: Google.Apis.CloudKMS.v1.dll
Syntax
public class CryptoKeyVersion : IDirectResponseSchema

Properties

Algorithm

Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

Declaration
[JsonProperty("algorithm")]
public virtual string Algorithm { get; set; }
Property Value
Type Description
string

Attestation

Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.

Declaration
[JsonProperty("attestation")]
public virtual KeyOperationAttestation Attestation { get; set; }
Property Value
Type Description
KeyOperationAttestation

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time at which this CryptoKeyVersion was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DestroyEventTime

object representation of DestroyEventTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DestroyEventTimeDateTimeOffset instead.")]
public virtual object DestroyEventTime { get; set; }
Property Value
Type Description
object

DestroyEventTimeDateTimeOffset

DateTimeOffset representation of DestroyEventTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? DestroyEventTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

DestroyEventTimeRaw

Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.

Declaration
[JsonProperty("destroyEventTime")]
public virtual string DestroyEventTimeRaw { get; set; }
Property Value
Type Description
string

DestroyTime

object representation of DestroyTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DestroyTimeDateTimeOffset instead.")]
public virtual object DestroyTime { get; set; }
Property Value
Type Description
object

DestroyTimeDateTimeOffset

DateTimeOffset representation of DestroyTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? DestroyTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

DestroyTimeRaw

Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.

Declaration
[JsonProperty("destroyTime")]
public virtual string DestroyTimeRaw { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExternalDestructionFailureReason

Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.

Declaration
[JsonProperty("externalDestructionFailureReason")]
public virtual string ExternalDestructionFailureReason { get; set; }
Property Value
Type Description
string

ExternalProtectionLevelOptions

ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.

Declaration
[JsonProperty("externalProtectionLevelOptions")]
public virtual ExternalProtectionLevelOptions ExternalProtectionLevelOptions { get; set; }
Property Value
Type Description
ExternalProtectionLevelOptions

GenerateTime

object representation of GenerateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use GenerateTimeDateTimeOffset instead.")]
public virtual object GenerateTime { get; set; }
Property Value
Type Description
object

GenerateTimeDateTimeOffset

DateTimeOffset representation of GenerateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? GenerateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

GenerateTimeRaw

Output only. The time this CryptoKeyVersion's key material was generated.

Declaration
[JsonProperty("generateTime")]
public virtual string GenerateTimeRaw { get; set; }
Property Value
Type Description
string

GenerationFailureReason

Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.

Declaration
[JsonProperty("generationFailureReason")]
public virtual string GenerationFailureReason { get; set; }
Property Value
Type Description
string

ImportFailureReason

Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.

Declaration
[JsonProperty("importFailureReason")]
public virtual string ImportFailureReason { get; set; }
Property Value
Type Description
string

ImportJob

Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.

Declaration
[JsonProperty("importJob")]
public virtual string ImportJob { get; set; }
Property Value
Type Description
string

ImportTime

object representation of ImportTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ImportTimeDateTimeOffset instead.")]
public virtual object ImportTime { get; set; }
Property Value
Type Description
object

ImportTimeDateTimeOffset

DateTimeOffset representation of ImportTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ImportTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ImportTimeRaw

Output only. The time at which this CryptoKeyVersion's key material was most recently imported.

Declaration
[JsonProperty("importTime")]
public virtual string ImportTimeRaw { get; set; }
Property Value
Type Description
string

Name

Output only. The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

ProtectionLevel

Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.

Declaration
[JsonProperty("protectionLevel")]
public virtual string ProtectionLevel { get; set; }
Property Value
Type Description
string

ReimportEligible

Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.

Declaration
[JsonProperty("reimportEligible")]
public virtual bool? ReimportEligible { get; set; }
Property Value
Type Description
bool?

State

The current state of the CryptoKeyVersion.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Implements