KeyClient.GetDeletedKey(String, CancellationToken) 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.
Gets the public part of a deleted key.
public virtual Azure.Response<Azure.Security.KeyVault.Keys.DeletedKey> GetDeletedKey (string name, System.Threading.CancellationToken cancellationToken = default);abstract member GetDeletedKey : string * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.DeletedKey>
override this.GetDeletedKey : string * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.DeletedKey>Public Overridable Function GetDeletedKey (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DeletedKey)Parameters
- name
- String
The name of the key.
- cancellationToken
- CancellationToken
A CancellationToken controlling the request lifetime.
Returns
Exceptions
name is an empty string.
name is null.
The server returned an error. See Message for details returned from the server.
Remarks
The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission.
