KeyClient.ReleaseKey Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ReleaseKey(ReleaseKeyOptions, CancellationToken) |
Releases a key. |
| ReleaseKey(String, String, CancellationToken) |
Releases the latest version of a key. |
ReleaseKey(ReleaseKeyOptions, CancellationToken)
- Source:
- KeyClient.cs
- 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
The key release result containing the released key.
Exceptions
options is null.
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.
Applies to
ReleaseKey(String, String, CancellationToken)
- Source:
- KeyClient.cs
- 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
The key release result containing the released key.
Exceptions
name or targetAttestationToken contains an empty string.
name or targetAttestationToken is null.
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.
