Show / Hide Table of Contents

Class CertificatesManagementClient

Service client instance for CertificatesManagement.

Inheritance
object
ClientBase
RegionalClientBase
CertificatesManagementClient
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.CertificatesmanagementService
Assembly: OCI.DotNetSDK.Certificatesmanagement.dll
Syntax
public class CertificatesManagementClient : RegionalClientBase, IDisposable

Constructors

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

Waiters

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

Methods

CancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels the scheduled deletion of the specified certificate authority (CA).

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

A response object containing details about the completed operation

Examples

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

CancelCertificateAuthorityVersionDeletion(CancelCertificateAuthorityVersionDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels the scheduled deletion of the specified certificate authority (CA) version. Canceling a scheduled deletion restores the CA version's lifecycle state to what it was before its scheduled deletion.

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

A response object containing details about the completed operation

Examples

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

CancelCertificateDeletion(CancelCertificateDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

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

A response object containing details about the completed operation

Examples

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

CancelCertificateVersionDeletion(CancelCertificateVersionDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels the scheduled deletion of the specified certificate version.

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

A response object containing details about the completed operation

Examples

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

ChangeCaBundleCompartment(ChangeCaBundleCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a CA bundle to a different compartment in 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<ChangeCaBundleCompartmentResponse> ChangeCaBundleCompartment(ChangeCaBundleCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeCaBundleCompartmentRequest 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<ChangeCaBundleCompartmentResponse>

A response object containing details about the completed operation

Examples

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

ChangeCertificateAuthorityCompartment(ChangeCertificateAuthorityCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a certificate authority (CA) to 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 source.

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

A response object containing details about the completed operation

Examples

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

ChangeCertificateCompartment(ChangeCertificateCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a certificate to 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<ChangeCertificateCompartmentResponse> ChangeCertificateCompartment(ChangeCertificateCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeCertificateCompartmentRequest 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<ChangeCertificateCompartmentResponse>

A response object containing details about the completed operation

Examples

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

CreateCaBundle(CreateCaBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new CA bundle according to the details of the request.

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

A response object containing details about the completed operation

Examples

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

CreateCertificate(CreateCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new certificate according to the details of the request.

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

A response object containing details about the completed operation

Examples

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

CreateCertificateAuthority(CreateCertificateAuthorityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new certificate authority (CA) according to the details of the request.

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

A response object containing details about the completed operation

Examples

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

DeleteCaBundle(DeleteCaBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified CA bundle.

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

A response object containing details about the completed operation

Examples

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

GetAssociation(GetAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details about the specified association.

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

A response object containing details about the completed operation

Examples

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

GetCaBundle(GetCaBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details about the specified CA 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.

GetCertificate(GetCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details about the specified certificate.

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

A response object containing details about the completed operation

Examples

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

GetCertificateAuthority(GetCertificateAuthorityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details about the specified certificate authority (CA).

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

A response object containing details about the completed operation

Examples

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

GetCertificateAuthorityVersion(GetCertificateAuthorityVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details about the specified certificate authority (CA) version.

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

A response object containing details about the completed operation

Examples

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

GetCertificateVersion(GetCertificateVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details about the specified version of a certificate.

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

A response object containing details about the completed operation

Examples

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

ListAssociations(ListAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all associations that match the query parameters. Optionally, you can use the parameter FilterByAssociationIdQueryParam to limit the result set to a single item that matches the specified association.

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

A response object containing details about the completed operation

Examples

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

ListCaBundles(ListCaBundlesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all CA bundles that match the query parameters. Optionally, you can use the parameter FilterByCaBundleIdQueryParam to limit the result set to a single item that matches the specified CA bundle.

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

A response object containing details about the completed operation

Examples

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

ListCertificateAuthorities(ListCertificateAuthoritiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all certificate authorities (CAs) in the specified compartment. Optionally, you can use the parameter FilterByCertificateAuthorityIdQueryParam to limit the results to a single item that matches the specified CA.

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

A response object containing details about the completed operation

Examples

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

ListCertificateAuthorityVersions(ListCertificateAuthorityVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all versions for the specified certificate authority (CA). Optionally, you can use the parameter FilterByVersionNumberQueryParam to limit the results to a single item that matches the specified version number.

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

A response object containing details about the completed operation

Examples

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

ListCertificateVersions(ListCertificateVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all certificate versions for the specified certificate. Optionally, you can use the parameter FilterByVersionNumberQueryParam to limit the result set to a single item that matches the specified version number.

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

A response object containing details about the completed operation

Examples

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

ListCertificates(ListCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all certificates that match the query parameters. Optionally, you can use the parameter FilterByCertificateIdQueryParam to limit the result set to a single item that matches the specified certificate.

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

A response object containing details about the completed operation

Examples

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

RevokeCertificateAuthorityVersion(RevokeCertificateAuthorityVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Revokes a certificate authority (CA) version.

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

A response object containing details about the completed operation

Examples

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

RevokeCertificateVersion(RevokeCertificateVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Revokes the specified certificate version.

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

A response object containing details about the completed operation

Examples

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

ScheduleCertificateAuthorityDeletion(ScheduleCertificateAuthorityDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Schedules the deletion of the specified certificate authority (CA). This sets the lifecycle state of the CA to PENDING_DELETION and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using GetCertificateAuthority.

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

A response object containing details about the completed operation

Examples

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

ScheduleCertificateAuthorityVersionDeletion(ScheduleCertificateAuthorityVersionDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Schedules the deletion of the specified certificate authority (CA) version. This sets the lifecycle state of the CA version to PENDING_DELETION and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using GetCertificateAuthorityVersion.

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

A response object containing details about the completed operation

Examples

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

ScheduleCertificateDeletion(ScheduleCertificateDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Schedules the deletion of the specified certificate. This sets the lifecycle state of the certificate to PENDING_DELETION and then deletes it after the specified retention period ends. You can subsequently use GetCertificate to determine the current deletion status.

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

A response object containing details about the completed operation

Examples

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

ScheduleCertificateVersionDeletion(ScheduleCertificateVersionDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Schedules the deletion of the specified certificate version. This sets the lifecycle state of the certificate version to PENDING_DELETION and then deletes it after the specified retention period ends. You can only delete a certificate version if the certificate version rotation state is marked as DEPRECATED. <br/> You can subsequently use GetCertificateVersion to determine the current certificate version deletion status.

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

A response object containing details about the completed operation

Examples

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

UpdateCaBundle(UpdateCaBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a CA bundle.

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

A response object containing details about the completed operation

Examples

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

UpdateCertificate(UpdateCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of a certificate.

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

A response object containing details about the completed operation

Examples

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

UpdateCertificateAuthority(UpdateCertificateAuthorityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of the specified certificate authority (CA).

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

A response object containing details about the completed operation

Examples

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

Implements

IDisposable
In this article
Back to top