ReleaseKeyOptions interface

Package:

@azure/keyvault-keys

Options for releaseKey

Extends

OperationOptions

Properties

algorithm	The KeyExportEncryptionAlgorithm to for protecting the exported key material.
nonce	A client provided nonce for freshness.
version	The version of the key to release. Defaults to the latest version of the key if omitted.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

algorithm

The KeyExportEncryptionAlgorithm to for protecting the exported key material.

algorithm?: string

Property Value

string

nonce

A client provided nonce for freshness.

nonce?: string

Property Value

string

version

The version of the key to release. Defaults to the latest version of the key if omitted.

version?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From coreClient.OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From coreClient.OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From coreClient.OperationOptions.tracingOptions