Class CertificatesClient
Service client instance for Certificates.
Implements
Inherited Members
Namespace: Oci.CertificatesService
Assembly: OCI.DotNetSDK.Certificates.dll
Syntax
public class CertificatesClient : RegionalClientBase, IDisposable
Constructors
CertificatesClient(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 CertificatesClient(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. |
Methods
GetCaBundle(GetCaBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a ca-bundle bundle.
Declaration
public Task<GetCaBundleResponse> GetCaBundle(GetCaBundleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCaBundleRequest | 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<GetCaBundleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCaBundle API.
GetCertificateAuthorityBundle(GetCertificateAuthorityBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a certificate authority bundle that matches either the specified stage
, name
, or versionNumber
parameter.
If none of these parameters are provided, the bundle for the certificate authority version marked as CURRENT
will be returned.
Declaration
public Task<GetCertificateAuthorityBundleResponse> GetCertificateAuthorityBundle(GetCertificateAuthorityBundleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCertificateAuthorityBundleRequest | 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<GetCertificateAuthorityBundleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCertificateAuthorityBundle API.
GetCertificateBundle(GetCertificateBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a certificate bundle that matches either the specified stage
, versionName
, or versionNumber
parameter.
If none of these parameters are provided, the bundle for the certificate version marked as CURRENT
will be returned.
<br/>
By default, the private key is not included in the query result, and a CertificateBundlePublicOnly is returned.
If the private key is needed, use the CertificateBundleTypeQueryParam parameter to get a CertificateBundleWithPrivateKey response.
Declaration
public Task<GetCertificateBundleResponse> GetCertificateBundle(GetCertificateBundleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCertificateBundleRequest | 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<GetCertificateBundleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCertificateBundle API.
ListCertificateAuthorityBundleVersions(ListCertificateAuthorityBundleVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all certificate authority bundle versions for the specified certificate authority.
Declaration
public Task<ListCertificateAuthorityBundleVersionsResponse> ListCertificateAuthorityBundleVersions(ListCertificateAuthorityBundleVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCertificateAuthorityBundleVersionsRequest | 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<ListCertificateAuthorityBundleVersionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCertificateAuthorityBundleVersions API.
ListCertificateBundleVersions(ListCertificateBundleVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all certificate bundle versions for the specified certificate.
Declaration
public Task<ListCertificateBundleVersionsResponse> ListCertificateBundleVersions(ListCertificateBundleVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCertificateBundleVersionsRequest | 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<ListCertificateBundleVersionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCertificateBundleVersions API.