Class VaultsClient

Service client instance for Vaults.

Inheritance

object

ClientBase

RegionalClientBase

VaultsClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.VaultService

Assembly: OCI.DotNetSDK.Vault.dll

Syntax

public class VaultsClient : RegionalClientBase, IDisposable

Constructors

VaultsClient(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 VaultsClient(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 VaultsPaginators Paginators { get; }

Property Value

Type	Description
VaultsPaginators

Waiters

Declaration

public VaultsWaiters Waiters { get; }

Property Value

Type	Description
VaultsWaiters

Methods

CancelSecretDeletion(CancelSecretDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels the pending deletion of the specified secret. Canceling a scheduled deletion restores the secret's lifecycle state to what it was before you scheduled the secret for deletion.

Declaration

public Task<CancelSecretDeletionResponse> CancelSecretDeletion(CancelSecretDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelSecretDeletionRequest	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<CancelSecretDeletionResponse>	A response object containing details about the completed operation

Examples

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

CancelSecretRotation(CancelSecretRotationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels the ongoing secret rotation. The cancellation is contingent on how far the rotation process has progressed. Upon cancelling a rotation, all future rotations are also disabled.

Declaration

public Task<CancelSecretRotationResponse> CancelSecretRotation(CancelSecretRotationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelSecretRotationRequest	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<CancelSecretRotationResponse>	A response object containing details about the completed operation

Examples

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

CancelSecretVersionDeletion(CancelSecretVersionDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels the scheduled deletion of a secret version.

Declaration

public Task<CancelSecretVersionDeletionResponse> CancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelSecretVersionDeletionRequest	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<CancelSecretVersionDeletionResponse>	A response object containing details about the completed operation

Examples

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

ChangeSecretCompartment(ChangeSecretCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a secret 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 secret.

Declaration

public Task<ChangeSecretCompartmentResponse> ChangeSecretCompartment(ChangeSecretCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeSecretCompartmentRequest	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<ChangeSecretCompartmentResponse>	A response object containing details about the completed operation

Examples

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

CreateSecret(CreateSecretRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new secret according to the details of the request. <br/> This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

Declaration

public Task<CreateSecretResponse> CreateSecret(CreateSecretRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSecretRequest	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<CreateSecretResponse>	A response object containing details about the completed operation

Examples

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

GetSecret(GetSecretRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified secret.

Declaration

public Task<GetSecretResponse> GetSecret(GetSecretRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecretRequest	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<GetSecretResponse>	A response object containing details about the completed operation

Examples

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

GetSecretVersion(GetSecretVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified version of a secret.

Declaration

public Task<GetSecretVersionResponse> GetSecretVersion(GetSecretVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecretVersionRequest	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<GetSecretVersionResponse>	A response object containing details about the completed operation

Examples

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

ListSecretVersions(ListSecretVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all secret versions for the specified secret.

Declaration

public Task<ListSecretVersionsResponse> ListSecretVersions(ListSecretVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecretVersionsRequest	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<ListSecretVersionsResponse>	A response object containing details about the completed operation

Examples

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

ListSecrets(ListSecretsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all secrets in the specified vault and compartment.

Declaration

public Task<ListSecretsResponse> ListSecrets(ListSecretsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecretsRequest	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<ListSecretsResponse>	A response object containing details about the completed operation

Examples

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

RotateSecret(RotateSecretRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details object

Declaration

public Task<RotateSecretResponse> RotateSecret(RotateSecretRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RotateSecretRequest	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<RotateSecretResponse>	A response object containing details about the completed operation

Examples

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

ScheduleSecretDeletion(ScheduleSecretDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Schedules the deletion of the specified secret. This sets the lifecycle state of the secret to PENDING_DELETION and then deletes it after the specified retention period ends.

Declaration

public Task<ScheduleSecretDeletionResponse> ScheduleSecretDeletion(ScheduleSecretDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ScheduleSecretDeletionRequest	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<ScheduleSecretDeletionResponse>	A response object containing details about the completed operation

Examples

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

ScheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only delete a secret version if the secret version rotation state is marked as DEPRECATED.

Declaration

public Task<ScheduleSecretVersionDeletionResponse> ScheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ScheduleSecretVersionDeletionRequest	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<ScheduleSecretVersionDeletionResponse>	A response object containing details about the completed operation

Examples

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

UpdateSecret(UpdateSecretRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a secret. Specifically, you can update the version number of the secret to make that version number the current version. You can also update a secret's description, its free-form or defined tags, rules and the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the same time. Furthermore, the secret must in an ACTIVE lifecycle state to be updated. <br/> This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

Declaration

public Task<UpdateSecretResponse> UpdateSecret(UpdateSecretRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSecretRequest	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<UpdateSecretResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable