Share via

ClientEncryptionKeyGetPropertiesResource interface

  • Reference
Package:
@azure/arm-cosmosdb

Cosmos DB client encryption key resource object.

Extends

ClientEncryptionKeyResource,ExtendedResourceProperties

Inherited Properties

encryptionAlgorithm

Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
etag

A system generated property representing the resource etag required for optimistic concurrency control. NOTE: This property will not be serialized. It can only be populated by the server.
id

Name of the ClientEncryptionKey
keyWrapMetadata

Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
rid

A system generated property. A unique identifier. NOTE: This property will not be serialized. It can only be populated by the server.
ts

A system generated property that denotes the last updated timestamp of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
wrappedDataEncryptionKey

Wrapped (encrypted) form of the key represented as a byte array.

Inherited Property Details

encryptionAlgorithm

Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.

encryptionAlgorithm?: string

Property Value

string

Inherited From ClientEncryptionKeyResource.encryptionAlgorithm

etag

A system generated property representing the resource etag required for optimistic concurrency control. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From ExtendedResourceProperties.etag

id

Name of the ClientEncryptionKey

id?: string

Property Value

string

Inherited From ClientEncryptionKeyResource.id

keyWrapMetadata

Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.

keyWrapMetadata?: KeyWrapMetadata

Property Value

KeyWrapMetadata

Inherited From ClientEncryptionKeyResource.keyWrapMetadata

rid

A system generated property. A unique identifier. NOTE: This property will not be serialized. It can only be populated by the server.

rid?: string

Property Value

string

Inherited From ExtendedResourceProperties.rid

ts

A system generated property that denotes the last updated timestamp of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

ts?: number

Property Value

number

Inherited From ExtendedResourceProperties.ts

wrappedDataEncryptionKey

Wrapped (encrypted) form of the key represented as a byte array.

wrappedDataEncryptionKey?: Uint8Array

Property Value

Uint8Array

Inherited From ClientEncryptionKeyResource.wrappedDataEncryptionKey