Class SecretsClient

Service client instance for Secrets.

Inheritance

object

ClientBase

RegionalClientBase

SecretsClient

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.SecretsService

Assembly: OCI.DotNetSDK.Secrets.dll

Syntax

public class SecretsClient : RegionalClientBase, IDisposable

Constructors

SecretsClient(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 SecretsClient(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 SecretsPaginators Paginators { get; }

Property Value

Type	Description
SecretsPaginators

Methods

GetSecretBundle(GetSecretBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a secret bundle that matches either the specified stage, secretVersionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the secret version marked as CURRENT will be returned.

Declaration

public Task<GetSecretBundleResponse> GetSecretBundle(GetSecretBundleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetSecretBundleByName(GetSecretBundleByNameRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified stage, secretVersionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the secret version marked as CURRENT is returned.

Declaration

public Task<GetSecretBundleByNameResponse> GetSecretBundleByName(GetSecretBundleByNameRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListSecretBundleVersions(ListSecretBundleVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all secret bundle versions for the specified secret.

Declaration

public Task<ListSecretBundleVersionsResponse> ListSecretBundleVersions(ListSecretBundleVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable