Class BlockstorageClient

Service client instance for Blockstorage.

Inheritance
object
ClientBase
RegionalClientBase
BlockstorageClient
Implements
Inherited Members
Namespace: Oci.CoreService
Assembly: OCI.DotNetSDK.Core.dll
Syntax
public class BlockstorageClient : RegionalClientBase, IDisposable

Constructors

BlockstorageClient(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 BlockstorageClient(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 BlockstoragePaginators Paginators { get; }
Property Value
Type Description
BlockstoragePaginators

Waiters

Declaration
public BlockstorageWaiters Waiters { get; }
Property Value
Type Description
BlockstorageWaiters

Methods

ChangeBootVolumeBackupCompartment(ChangeBootVolumeBackupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a boot volume backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeBootVolumeBackupCompartmentResponse> ChangeBootVolumeBackupCompartment(ChangeBootVolumeBackupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeBootVolumeBackupCompartmentRequest 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<ChangeBootVolumeBackupCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeBootVolumeBackupCompartment API.

ChangeBootVolumeCompartment(ChangeBootVolumeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a boot volume into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeBootVolumeCompartmentResponse> ChangeBootVolumeCompartment(ChangeBootVolumeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeBootVolumeCompartmentRequest 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<ChangeBootVolumeCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeBootVolumeCompartment API.

ChangeVolumeBackupCompartment(ChangeVolumeBackupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a volume backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeVolumeBackupCompartmentResponse> ChangeVolumeBackupCompartment(ChangeVolumeBackupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVolumeBackupCompartmentRequest 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<ChangeVolumeBackupCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeVolumeBackupCompartment API.

ChangeVolumeCompartment(ChangeVolumeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a volume into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeVolumeCompartmentResponse> ChangeVolumeCompartment(ChangeVolumeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVolumeCompartmentRequest 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<ChangeVolumeCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeVolumeCompartment API.

ChangeVolumeGroupBackupCompartment(ChangeVolumeGroupBackupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a volume group backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeVolumeGroupBackupCompartmentResponse> ChangeVolumeGroupBackupCompartment(ChangeVolumeGroupBackupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVolumeGroupBackupCompartmentRequest 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<ChangeVolumeGroupBackupCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeVolumeGroupBackupCompartment API.

ChangeVolumeGroupCompartment(ChangeVolumeGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a volume group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeVolumeGroupCompartmentResponse> ChangeVolumeGroupCompartment(ChangeVolumeGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVolumeGroupCompartmentRequest 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<ChangeVolumeGroupCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeVolumeGroupCompartment API.

CopyBootVolumeBackup(CopyBootVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a boot volume backup copy in specified region. For general information about volume backups, see Overview of Boot Volume Backups

Declaration
public Task<CopyBootVolumeBackupResponse> CopyBootVolumeBackup(CopyBootVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CopyBootVolumeBackupRequest 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<CopyBootVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CopyBootVolumeBackup API.

CopyVolumeBackup(CopyVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a volume backup copy in specified region. For general information about volume backups, see Overview of Block Volume Service Backups

Declaration
public Task<CopyVolumeBackupResponse> CopyVolumeBackup(CopyVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CopyVolumeBackupRequest 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<CopyVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CopyVolumeBackup API.

CopyVolumeGroupBackup(CopyVolumeGroupBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a volume group backup copy in specified region. For general information about volume group backups, see Overview of Block Volume Backups.

Declaration
public Task<CopyVolumeGroupBackupResponse> CopyVolumeGroupBackup(CopyVolumeGroupBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CopyVolumeGroupBackupRequest 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<CopyVolumeGroupBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CopyVolumeGroupBackup API.

CreateBootVolume(CreateBootVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. For general information about boot volumes, see Boot Volumes. You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

Declaration
public Task<CreateBootVolumeResponse> CreateBootVolume(CreateBootVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateBootVolumeRequest 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<CreateBootVolumeResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateBootVolume API.

CreateBootVolumeBackup(CreateBootVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, see Overview of Boot Volume Backups <br/> When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

Declaration
public Task<CreateBootVolumeBackupResponse> CreateBootVolumeBackup(CreateBootVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateBootVolumeBackupRequest 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<CreateBootVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateBootVolumeBackup API.

CreateVolume(CreateVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). For general information about block volumes, see Overview of Block Volume Service. <br/> A volume and instance can be in separate compartments but must be in the same availability domain. For information about access control and compartments, see Overview of the IAM Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API. <br/> You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

Declaration
public Task<CreateVolumeResponse> CreateVolume(CreateVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVolumeRequest 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<CreateVolumeResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateVolume API.

CreateVolumeBackup(CreateVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new backup of the specified volume. For general information about volume backups, see Overview of Block Volume Service Backups <br/> When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

Declaration
public Task<CreateVolumeBackupResponse> CreateVolumeBackup(CreateVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVolumeBackupRequest 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<CreateVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateVolumeBackup API.

CreateVolumeBackupPolicy(CreateVolumeBackupPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new user defined backup policy. <br/> For more information about Oracle defined backup policies and user defined backup policies, see Policy-Based Backups.

Declaration
public Task<CreateVolumeBackupPolicyResponse> CreateVolumeBackupPolicy(CreateVolumeBackupPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVolumeBackupPolicyRequest 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<CreateVolumeBackupPolicyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateVolumeBackupPolicy API.

CreateVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Assigns a volume backup policy to the specified volume. Note that a given volume can only have one backup policy assigned to it. If this operation is used for a volume that already has a different backup policy assigned, the prior backup policy will be silently unassigned.

Declaration
public Task<CreateVolumeBackupPolicyAssignmentResponse> CreateVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVolumeBackupPolicyAssignmentRequest 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<CreateVolumeBackupPolicyAssignmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateVolumeBackupPolicyAssignment API.

CreateVolumeGroup(CreateVolumeGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup. You may optionally specify a display name for the volume group, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information. <br/> For more information, see Volume Groups.

Declaration
public Task<CreateVolumeGroupResponse> CreateVolumeGroup(CreateVolumeGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVolumeGroupRequest 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<CreateVolumeGroupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateVolumeGroup API.

CreateVolumeGroupBackup(CreateVolumeGroupBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new backup volume group of the specified volume group. For more information, see Volume Groups.

Declaration
public Task<CreateVolumeGroupBackupResponse> CreateVolumeGroupBackup(CreateVolumeGroupBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVolumeGroupBackupRequest 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<CreateVolumeGroupBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateVolumeGroupBackup API.

DeleteBootVolume(DeleteBootVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified boot volume. The volume cannot have an active connection to an instance. To disconnect the boot volume from a connected instance, see Disconnecting From a Boot Volume. Warning: All data on the boot volume will be permanently lost when the boot volume is deleted.

Declaration
public Task<DeleteBootVolumeResponse> DeleteBootVolume(DeleteBootVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteBootVolumeRequest 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<DeleteBootVolumeResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteBootVolume API.

DeleteBootVolumeBackup(DeleteBootVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a boot volume backup.

Declaration
public Task<DeleteBootVolumeBackupResponse> DeleteBootVolumeBackup(DeleteBootVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteBootVolumeBackupRequest 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<DeleteBootVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteBootVolumeBackup API.

DeleteBootVolumeKmsKey(DeleteBootVolumeKmsKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes the specified boot volume's assigned Vault Service encryption key.

Declaration
public Task<DeleteBootVolumeKmsKeyResponse> DeleteBootVolumeKmsKey(DeleteBootVolumeKmsKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteBootVolumeKmsKeyRequest 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<DeleteBootVolumeKmsKeyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteBootVolumeKmsKey API.

DeleteVolume(DeleteVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified volume. The volume cannot have an active connection to an instance. To disconnect the volume from a connected instance, see Disconnecting From a Volume. Warning: All data on the volume will be permanently lost when the volume is deleted.

Declaration
public Task<DeleteVolumeResponse> DeleteVolume(DeleteVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVolumeRequest 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<DeleteVolumeResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteVolume API.

DeleteVolumeBackup(DeleteVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a volume backup.

Declaration
public Task<DeleteVolumeBackupResponse> DeleteVolumeBackup(DeleteVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVolumeBackupRequest 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<DeleteVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteVolumeBackup API.

DeleteVolumeBackupPolicy(DeleteVolumeBackupPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a user defined backup policy. For more information about user defined backup policies, see Policy-Based Backups. <br/> Avoid entering confidential information.

Declaration
public Task<DeleteVolumeBackupPolicyResponse> DeleteVolumeBackupPolicy(DeleteVolumeBackupPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVolumeBackupPolicyRequest 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<DeleteVolumeBackupPolicyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteVolumeBackupPolicy API.

DeleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a volume backup policy assignment.

Declaration
public Task<DeleteVolumeBackupPolicyAssignmentResponse> DeleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVolumeBackupPolicyAssignmentRequest 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<DeleteVolumeBackupPolicyAssignmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteVolumeBackupPolicyAssignment API.

DeleteVolumeGroup(DeleteVolumeGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted. For more information, see Volume Groups.

Declaration
public Task<DeleteVolumeGroupResponse> DeleteVolumeGroup(DeleteVolumeGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVolumeGroupRequest 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<DeleteVolumeGroupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteVolumeGroup API.

DeleteVolumeGroupBackup(DeleteVolumeGroupBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a volume group backup. This operation deletes all the backups in the volume group. For more information, see Volume Groups.

Declaration
public Task<DeleteVolumeGroupBackupResponse> DeleteVolumeGroupBackup(DeleteVolumeGroupBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVolumeGroupBackupRequest 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<DeleteVolumeGroupBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteVolumeGroupBackup API.

DeleteVolumeKmsKey(DeleteVolumeKmsKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes the specified volume's assigned Vault service encryption key.

Declaration
public Task<DeleteVolumeKmsKeyResponse> DeleteVolumeKmsKey(DeleteVolumeKmsKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVolumeKmsKeyRequest 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<DeleteVolumeKmsKeyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteVolumeKmsKey API.

GetBlockVolumeReplica(GetBlockVolumeReplicaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified block volume replica.

Declaration
public Task<GetBlockVolumeReplicaResponse> GetBlockVolumeReplica(GetBlockVolumeReplicaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBlockVolumeReplicaRequest 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<GetBlockVolumeReplicaResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetBlockVolumeReplica API.

GetBootVolume(GetBootVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified boot volume.

Declaration
public Task<GetBootVolumeResponse> GetBootVolume(GetBootVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBootVolumeRequest 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<GetBootVolumeResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetBootVolume API.

GetBootVolumeBackup(GetBootVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified boot volume backup.

Declaration
public Task<GetBootVolumeBackupResponse> GetBootVolumeBackup(GetBootVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBootVolumeBackupRequest 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<GetBootVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetBootVolumeBackup API.

GetBootVolumeKmsKey(GetBootVolumeKmsKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the Vault service encryption key assigned to the specified boot volume.

Declaration
public Task<GetBootVolumeKmsKeyResponse> GetBootVolumeKmsKey(GetBootVolumeKmsKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBootVolumeKmsKeyRequest 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<GetBootVolumeKmsKeyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetBootVolumeKmsKey API.

GetBootVolumeReplica(GetBootVolumeReplicaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified boot volume replica.

Declaration
public Task<GetBootVolumeReplicaResponse> GetBootVolumeReplica(GetBootVolumeReplicaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBootVolumeReplicaRequest 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<GetBootVolumeReplicaResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetBootVolumeReplica API.

GetVolume(GetVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified volume.

Declaration
public Task<GetVolumeResponse> GetVolume(GetVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVolumeRequest 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<GetVolumeResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetVolume API.

GetVolumeBackup(GetVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified volume backup.

Declaration
public Task<GetVolumeBackupResponse> GetVolumeBackup(GetVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVolumeBackupRequest 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<GetVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetVolumeBackup API.

GetVolumeBackupPolicy(GetVolumeBackupPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified volume backup policy.

Declaration
public Task<GetVolumeBackupPolicyResponse> GetVolumeBackupPolicy(GetVolumeBackupPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVolumeBackupPolicyRequest 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<GetVolumeBackupPolicyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetVolumeBackupPolicy API.

GetVolumeBackupPolicyAssetAssignment(GetVolumeBackupPolicyAssetAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the volume backup policy assignment for the specified volume. The assetId query parameter is required, and the returned list will contain at most one item, since volume can only have one volume backup policy assigned at a time.

Declaration
public Task<GetVolumeBackupPolicyAssetAssignmentResponse> GetVolumeBackupPolicyAssetAssignment(GetVolumeBackupPolicyAssetAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVolumeBackupPolicyAssetAssignmentRequest 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<GetVolumeBackupPolicyAssetAssignmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetVolumeBackupPolicyAssetAssignment API.

GetVolumeBackupPolicyAssignment(GetVolumeBackupPolicyAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified volume backup policy assignment.

Declaration
public Task<GetVolumeBackupPolicyAssignmentResponse> GetVolumeBackupPolicyAssignment(GetVolumeBackupPolicyAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVolumeBackupPolicyAssignmentRequest 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<GetVolumeBackupPolicyAssignmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetVolumeBackupPolicyAssignment API.

GetVolumeGroup(GetVolumeGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified volume group. For more information, see Volume Groups.

Declaration
public Task<GetVolumeGroupResponse> GetVolumeGroup(GetVolumeGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVolumeGroupRequest 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<GetVolumeGroupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetVolumeGroup API.

GetVolumeGroupBackup(GetVolumeGroupBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified volume group backup. For more information, see Volume Groups.

Declaration
public Task<GetVolumeGroupBackupResponse> GetVolumeGroupBackup(GetVolumeGroupBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVolumeGroupBackupRequest 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<GetVolumeGroupBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetVolumeGroupBackup API.

GetVolumeGroupReplica(GetVolumeGroupReplicaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information for the specified volume group replica.

Declaration
public Task<GetVolumeGroupReplicaResponse> GetVolumeGroupReplica(GetVolumeGroupReplicaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVolumeGroupReplicaRequest 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<GetVolumeGroupReplicaResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetVolumeGroupReplica API.

GetVolumeKmsKey(GetVolumeKmsKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the Vault service encryption key assigned to the specified volume.

Declaration
public Task<GetVolumeKmsKeyResponse> GetVolumeKmsKey(GetVolumeKmsKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVolumeKmsKeyRequest 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<GetVolumeKmsKeyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetVolumeKmsKey API.

ListBlockVolumeReplicas(ListBlockVolumeReplicasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the block volume replicas in the specified compartment and availability domain.

Declaration
public Task<ListBlockVolumeReplicasResponse> ListBlockVolumeReplicas(ListBlockVolumeReplicasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBlockVolumeReplicasRequest 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<ListBlockVolumeReplicasResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListBlockVolumeReplicas API.

ListBootVolumeBackups(ListBootVolumeBackupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.

Declaration
public Task<ListBootVolumeBackupsResponse> ListBootVolumeBackups(ListBootVolumeBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBootVolumeBackupsRequest 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<ListBootVolumeBackupsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListBootVolumeBackups API.

ListBootVolumeReplicas(ListBootVolumeReplicasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the boot volume replicas in the specified compartment and availability domain.

Declaration
public Task<ListBootVolumeReplicasResponse> ListBootVolumeReplicas(ListBootVolumeReplicasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBootVolumeReplicasRequest 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<ListBootVolumeReplicasResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListBootVolumeReplicas API.

ListBootVolumes(ListBootVolumesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the boot volumes in the specified compartment and availability domain.

Declaration
public Task<ListBootVolumesResponse> ListBootVolumes(ListBootVolumesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBootVolumesRequest 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<ListBootVolumesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListBootVolumes API.

ListVolumeBackupPolicies(ListVolumeBackupPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all the volume backup policies available in the specified compartment. <br/> For more information about Oracle defined backup policies and user defined backup policies, see Policy-Based Backups.

Declaration
public Task<ListVolumeBackupPoliciesResponse> ListVolumeBackupPolicies(ListVolumeBackupPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVolumeBackupPoliciesRequest 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<ListVolumeBackupPoliciesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListVolumeBackupPolicies API.

ListVolumeBackups(ListVolumeBackupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the volume backups in the specified compartment. You can filter the results by volume.

Declaration
public Task<ListVolumeBackupsResponse> ListVolumeBackups(ListVolumeBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVolumeBackupsRequest 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<ListVolumeBackupsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListVolumeBackups API.

ListVolumeGroupBackups(ListVolumeGroupBackupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the volume group backups in the specified compartment. You can filter the results by volume group. For more information, see Volume Groups.

Declaration
public Task<ListVolumeGroupBackupsResponse> ListVolumeGroupBackups(ListVolumeGroupBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVolumeGroupBackupsRequest 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<ListVolumeGroupBackupsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListVolumeGroupBackups API.

ListVolumeGroupReplicas(ListVolumeGroupReplicasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the volume group replicas in the specified compartment. You can filter the results by volume group. For more information, see Volume Group Replication.

Declaration
public Task<ListVolumeGroupReplicasResponse> ListVolumeGroupReplicas(ListVolumeGroupReplicasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVolumeGroupReplicasRequest 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<ListVolumeGroupReplicasResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListVolumeGroupReplicas API.

ListVolumeGroups(ListVolumeGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the volume groups in the specified compartment and availability domain. For more information, see Volume Groups.

Declaration
public Task<ListVolumeGroupsResponse> ListVolumeGroups(ListVolumeGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVolumeGroupsRequest 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<ListVolumeGroupsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListVolumeGroups API.

ListVolumes(ListVolumesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the volumes in the specified compartment and availability domain.

Declaration
public Task<ListVolumesResponse> ListVolumes(ListVolumesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVolumesRequest 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<ListVolumesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListVolumes API.

UpdateBootVolume(UpdateBootVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified boot volume's display name, defined tags, and free-form tags.

Declaration
public Task<UpdateBootVolumeResponse> UpdateBootVolume(UpdateBootVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBootVolumeRequest 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<UpdateBootVolumeResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateBootVolume API.

UpdateBootVolumeBackup(UpdateBootVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the display name for the specified boot volume backup. Avoid entering confidential information.

Declaration
public Task<UpdateBootVolumeBackupResponse> UpdateBootVolumeBackup(UpdateBootVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBootVolumeBackupRequest 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<UpdateBootVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateBootVolumeBackup API.

UpdateBootVolumeKmsKey(UpdateBootVolumeKmsKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified volume with a new Vault service master encryption key.

Declaration
public Task<UpdateBootVolumeKmsKeyResponse> UpdateBootVolumeKmsKey(UpdateBootVolumeKmsKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBootVolumeKmsKeyRequest 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<UpdateBootVolumeKmsKeyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateBootVolumeKmsKey API.

UpdateVolume(UpdateVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified volume's display name. Avoid entering confidential information.

Declaration
public Task<UpdateVolumeResponse> UpdateVolume(UpdateVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVolumeRequest 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<UpdateVolumeResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateVolume API.

UpdateVolumeBackup(UpdateVolumeBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the display name for the specified volume backup. Avoid entering confidential information.

Declaration
public Task<UpdateVolumeBackupResponse> UpdateVolumeBackup(UpdateVolumeBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVolumeBackupRequest 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<UpdateVolumeBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateVolumeBackup API.

UpdateVolumeBackupPolicy(UpdateVolumeBackupPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a user defined backup policy. For more information about user defined backup policies, see Policy-Based Backups. <br/> Avoid entering confidential information.

Declaration
public Task<UpdateVolumeBackupPolicyResponse> UpdateVolumeBackupPolicy(UpdateVolumeBackupPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVolumeBackupPolicyRequest 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<UpdateVolumeBackupPolicyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateVolumeBackupPolicy API.

UpdateVolumeGroup(UpdateVolumeGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the set of volumes in a volume group along with the display name. Use this operation to add or remove volumes in a volume group. Specify the full list of volume IDs to include in the volume group. If the volume ID is not specified in the call, it will be removed from the volume group. Avoid entering confidential information. <br/> For more information, see Volume Groups.

Declaration
public Task<UpdateVolumeGroupResponse> UpdateVolumeGroup(UpdateVolumeGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVolumeGroupRequest 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<UpdateVolumeGroupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateVolumeGroup API.

UpdateVolumeGroupBackup(UpdateVolumeGroupBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the display name for the specified volume group backup. For more information, see Volume Groups.

Declaration
public Task<UpdateVolumeGroupBackupResponse> UpdateVolumeGroupBackup(UpdateVolumeGroupBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVolumeGroupBackupRequest 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<UpdateVolumeGroupBackupResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateVolumeGroupBackup API.

UpdateVolumeKmsKey(UpdateVolumeKmsKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified volume with a new Key Management master encryption key.

Declaration
public Task<UpdateVolumeKmsKeyResponse> UpdateVolumeKmsKey(UpdateVolumeKmsKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVolumeKmsKeyRequest 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<UpdateVolumeKmsKeyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateVolumeKmsKey API.

Implements