Class KmsManagementClient
Service client instance for KmsManagement.
Implements
Inherited Members
Namespace: Oci.KeymanagementService
Assembly: OCI.DotNetSDK.Keymanagement.dll
Syntax
public class KmsManagementClient : ClientBase, IDisposableConstructors
KmsManagementClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public KmsManagementClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)Parameters
| Type | Name | Description |
|---|---|---|
| IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
| ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
| string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public KmsManagementPaginators Paginators { get; }Property Value
| Type | Description |
|---|---|
| KmsManagementPaginators |
Waiters
Declaration
public KmsManagementWaiters Waiters { get; }Property Value
| Type | Description |
|---|---|
| KmsManagementWaiters |
Methods
BackupKey(BackupKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore the key later. The file also contains the metadata of the vault that the key belonged to.
Declaration
public Task<BackupKeyResponse> BackupKey(BackupKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| BackupKeyRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<BackupKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BackupKey API.
CancelKeyDeletion(CancelKeyDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels the scheduled deletion of the specified key. Canceling a scheduled deletion restores the key's lifecycle state to what it was before its scheduled deletion. <br/> As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<CancelKeyDeletionResponse> CancelKeyDeletion(CancelKeyDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| CancelKeyDeletionRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<CancelKeyDeletionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelKeyDeletion API.
CancelKeyVersionDeletion(CancelKeyVersionDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels the scheduled deletion of the specified key version. Canceling a scheduled deletion restores the key version to its lifecycle state from before its scheduled deletion. <br/> As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<CancelKeyVersionDeletionResponse> CancelKeyVersionDeletion(CancelKeyVersionDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| CancelKeyVersionDeletionRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<CancelKeyVersionDeletionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelKeyVersionDeletion API.
ChangeKeyCompartment(ChangeKeyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a key into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment. <br/> When provided, if-match is checked against the ETag values of the key. <br/> As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<ChangeKeyCompartmentResponse> ChangeKeyCompartment(ChangeKeyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| ChangeKeyCompartmentRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<ChangeKeyCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeKeyCompartment API.
CreateKey(CreateKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new master encryption key. <br/> As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<CreateKeyResponse> CreateKey(CreateKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| CreateKeyRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<CreateKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateKey API.
CreateKeyVersion(CreateKeyVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Generates a new KeyVersion resource that provides new cryptographic
material for a master encryption key. The key must be in an ENABLED state to be rotated.
<br/>
As a management operation, this call is subject to a Key Management limit that applies to the total number
of requests across all management write operations. Key Management might throttle this call to reject an
otherwise valid request when the total rate of management write operations exceeds 10 requests per second
for a given tenancy.
Declaration
public Task<CreateKeyVersionResponse> CreateKeyVersion(CreateKeyVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| CreateKeyVersionRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<CreateKeyVersionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateKeyVersion API.
DisableKey(DisableKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Disables a master encryption key so it can no longer be used for encryption, decryption, or generating new data encryption keys. <br/> As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<DisableKeyResponse> DisableKey(DisableKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| DisableKeyRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<DisableKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DisableKey API.
EnableKey(EnableKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Enables a master encryption key so it can be used for encryption, decryption, or generating new data encryption keys. <br/> As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<EnableKeyResponse> EnableKey(EnableKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| EnableKeyRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<EnableKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EnableKey API.
GetKey(GetKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified master encryption key. <br/> As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<GetKeyResponse> GetKey(GetKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| GetKeyRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<GetKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetKey API.
GetKeyVersion(GetKeyVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified key version. <br/> As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<GetKeyVersionResponse> GetKeyVersion(GetKeyVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| GetKeyVersionRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<GetKeyVersionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetKeyVersion API.
GetReplicationStatus(GetReplicationStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
When a vault has a replica, each operation on the vault or its resources, such as keys, is replicated and has an associated replicationId. Replication status provides details about whether the operation associated with the given replicationId has been successfully applied across replicas.
Declaration
public Task<GetReplicationStatusResponse> GetReplicationStatus(GetReplicationStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| GetReplicationStatusRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<GetReplicationStatusResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetReplicationStatus API.
GetWrappingKey(GetWrappingKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and unwraps AES key material for import into Key Management.
Declaration
public Task<GetWrappingKeyResponse> GetWrappingKey(GetWrappingKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| GetWrappingKeyRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<GetWrappingKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWrappingKey API.
ImportKey(ImportKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Imports AES and RSA keys to create a new key. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports both RSA and AES keys. The AES keys are symmetric keys of length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). Furthermore, the key length must match what you specify at the time of import. When importing an asymmetric key, only private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.
Declaration
public Task<ImportKeyResponse> ImportKey(ImportKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| ImportKeyRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<ImportKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportKey API.
ImportKeyVersion(ImportKeyVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Imports AES key material to create a new key version and then rotate the key to begin using the new key version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match the length of the specified key and what you specify as the length at the time of import. When importing an asymmetric key, only the private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.
Declaration
public Task<ImportKeyVersionResponse> ImportKeyVersion(ImportKeyVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| ImportKeyVersionRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<ImportKeyVersionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportKeyVersion API.
ListKeyVersions(ListKeyVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all KeyVersion resources for the specified master encryption key. <br/> As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<ListKeyVersionsResponse> ListKeyVersions(ListKeyVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| ListKeyVersionsRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<ListKeyVersionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListKeyVersions API.
ListKeys(ListKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the master encryption keys in the specified vault and compartment. <br/> As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<ListKeysResponse> ListKeys(ListKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| ListKeysRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<ListKeysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListKeys API.
RestoreKeyFromFile(RestoreKeyFromFileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Restores the specified key to the specified vault, based on information in the backup file provided. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.
Declaration
public Task<RestoreKeyFromFileResponse> RestoreKeyFromFile(RestoreKeyFromFileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| RestoreKeyFromFileRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<RestoreKeyFromFileResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RestoreKeyFromFile API.
RestoreKeyFromObjectStore(RestoreKeyFromObjectStoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Restores the specified key to the specified vault from an Oracle Cloud Infrastructure Object Storage location. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.
Declaration
public Task<RestoreKeyFromObjectStoreResponse> RestoreKeyFromObjectStore(RestoreKeyFromObjectStoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| RestoreKeyFromObjectStoreRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<RestoreKeyFromObjectStoreResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RestoreKeyFromObjectStore API.
ScheduleKeyDeletion(ScheduleKeyDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Schedules the deletion of the specified key. This sets the lifecycle state of the key
to PENDING_DELETION and then deletes it after the specified retention period ends.
<br/>
As a provisioning operation, this call is subject to a Key Management limit that applies to
the total number of requests across all provisioning write operations. Key Management might
throttle this call to reject an otherwise valid request when the total rate of provisioning
write operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<ScheduleKeyDeletionResponse> ScheduleKeyDeletion(ScheduleKeyDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| ScheduleKeyDeletionRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<ScheduleKeyDeletionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ScheduleKeyDeletion API.
ScheduleKeyVersionDeletion(ScheduleKeyVersionDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Schedules the deletion of the specified key version. This sets the lifecycle state of the key version
to PENDING_DELETION and then deletes it after the specified retention period ends.
<br/>
As a provisioning operation, this call is subject to a Key Management limit that applies to
the total number of requests across all provisioning write operations. Key Management might
throttle this call to reject an otherwise valid request when the total rate of provisioning
write operations exceeds 10 requests per second for a given tenancy.
Declaration
public Task<ScheduleKeyVersionDeletionResponse> ScheduleKeyVersionDeletion(ScheduleKeyVersionDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| ScheduleKeyVersionDeletionRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<ScheduleKeyVersionDeletionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ScheduleKeyVersionDeletion API.
UpdateKey(UpdateKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the properties of a master encryption key. Specifically, you can update the
displayName, freeformTags, and definedTags properties. Furthermore,
the key must be in an ENABLED or CREATING state to be updated.
<br/>
As a management operation, this call is subject to a Key Management limit that applies to the total number
of requests across all management write operations. Key Management might throttle this call to reject an
otherwise valid request when the total rate of management write operations exceeds 10 requests per second
for a given tenancy.
Declaration
public Task<UpdateKeyResponse> UpdateKey(UpdateKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateKeyRequest | request | The request object containing the details to send. Required. |
| RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
| CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
| HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
| Type | Description |
|---|---|
| Task<UpdateKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateKey API.