KeyClient.ReleaseKey Method

Definition

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.6.0

Overloads

ReleaseKey(ReleaseKeyOptions, CancellationToken)	Releases a key.
ReleaseKey(String, String, CancellationToken)	Releases the latest version of a key.

ReleaseKey(ReleaseKeyOptions, CancellationToken)

Source:

KeyClient.cs

Releases a key.

public virtual Azure.Response<Azure.Security.KeyVault.Keys.ReleaseKeyResult> ReleaseKey (Azure.Security.KeyVault.Keys.ReleaseKeyOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member ReleaseKey : Azure.Security.KeyVault.Keys.ReleaseKeyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.ReleaseKeyResult>
override this.ReleaseKey : Azure.Security.KeyVault.Keys.ReleaseKeyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.ReleaseKeyResult>

Public Overridable Function ReleaseKey (options As ReleaseKeyOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ReleaseKeyResult)

Parameters

options

ReleaseKeyOptions

ReleaseKeyOptions containing the name, attestation assertion for the target, and additional options to release a key.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Response<ReleaseKeyResult>

The key release result containing the released key.

Exceptions

ArgumentNullException

options is null.

RequestFailedException

The server returned an error. See Message for details returned from the server.

Remarks

The key must be exportable. This operation requires the keys/release permission.

ReleaseKey(String, String, CancellationToken)

Source:

KeyClient.cs

Releases the latest version of a key.

public virtual Azure.Response<Azure.Security.KeyVault.Keys.ReleaseKeyResult> ReleaseKey (string name, string targetAttestationToken, System.Threading.CancellationToken cancellationToken = default);

abstract member ReleaseKey : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.ReleaseKeyResult>
override this.ReleaseKey : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.ReleaseKeyResult>

Public Overridable Function ReleaseKey (name As String, targetAttestationToken As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ReleaseKeyResult)

Parameters

name

String

The name of the key to release.

targetAttestationToken

String

The attestation assertion for the target of the key release.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Response<ReleaseKeyResult>

The key release result containing the released key.

Exceptions

ArgumentException

name or targetAttestationToken contains an empty string.

ArgumentNullException

name or targetAttestationToken is null.

RequestFailedException

The server returned an error. See Message for details returned from the server.

Remarks

The key must be exportable. This operation requires the keys/release permission.