Share via

Certificates interface

  • Reference
Package:
@azure/arm-sphere

Interface representing a Certificates.

Methods

get(string, string, string, CertificatesGetOptionalParams)

Get a Certificate
listByCatalog(string, string, CertificatesListByCatalogOptionalParams)

List Certificate resources by Catalog
retrieveCertChain(string, string, string, CertificatesRetrieveCertChainOptionalParams)

Retrieves cert chain.
retrieveProofOfPossessionNonce(string, string, string, ProofOfPossessionNonceRequest, CertificatesRetrieveProofOfPossessionNonceOptionalParams)

Gets the proof of possession nonce.

Method Details

get(string, string, string, CertificatesGetOptionalParams)

Get a Certificate

function get(resourceGroupName: string, catalogName: string, serialNumber: string, options?: CertificatesGetOptionalParams): Promise<Certificate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

catalogName

string

Name of catalog

serialNumber

string

Serial number of the certificate. Use '.default' to get current active certificate.

options
CertificatesGetOptionalParams

The options parameters.

Returns

Promise<Certificate>

listByCatalog(string, string, CertificatesListByCatalogOptionalParams)

List Certificate resources by Catalog

function listByCatalog(resourceGroupName: string, catalogName: string, options?: CertificatesListByCatalogOptionalParams): PagedAsyncIterableIterator<Certificate, Certificate[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

catalogName

string

Name of catalog

options
CertificatesListByCatalogOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Certificate, Certificate[], PageSettings>

retrieveCertChain(string, string, string, CertificatesRetrieveCertChainOptionalParams)

Retrieves cert chain.

function retrieveCertChain(resourceGroupName: string, catalogName: string, serialNumber: string, options?: CertificatesRetrieveCertChainOptionalParams): Promise<CertificateChainResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

catalogName

string

Name of catalog

serialNumber

string

Serial number of the certificate. Use '.default' to get current active certificate.

options
CertificatesRetrieveCertChainOptionalParams

The options parameters.

Returns

Promise<CertificateChainResponse>

retrieveProofOfPossessionNonce(string, string, string, ProofOfPossessionNonceRequest, CertificatesRetrieveProofOfPossessionNonceOptionalParams)

Gets the proof of possession nonce.

function retrieveProofOfPossessionNonce(resourceGroupName: string, catalogName: string, serialNumber: string, proofOfPossessionNonceRequest: ProofOfPossessionNonceRequest, options?: CertificatesRetrieveProofOfPossessionNonceOptionalParams): Promise<ProofOfPossessionNonceResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

catalogName

string

Name of catalog

serialNumber

string

Serial number of the certificate. Use '.default' to get current active certificate.

proofOfPossessionNonceRequest
ProofOfPossessionNonceRequest

Proof of possession nonce request body

options
CertificatesRetrieveProofOfPossessionNonceOptionalParams

The options parameters.

Returns

Promise<ProofOfPossessionNonceResponse>