Share via

Certificate interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a Certificate.

Methods

createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)

Creates or updates the certificate being used for authentication with the backend.
delete(string, string, string, string, CertificateDeleteOptionalParams)

Deletes specific certificate.
get(string, string, string, CertificateGetOptionalParams)

Gets the details of the certificate specified by its identifier.
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the certificate specified by its identifier.
listByService(string, string, CertificateListByServiceOptionalParams)

Lists a collection of all certificates in the specified service instance.
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)

From KeyVault, Refresh the certificate being used for authentication with the backend.

Method Details

createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)

Creates or updates the certificate being used for authentication with the backend.

function createOrUpdate(resourceGroupName: string, serviceName: string, certificateId: string, parameters: CertificateCreateOrUpdateParameters, options?: CertificateCreateOrUpdateOptionalParams): Promise<CertificateCreateOrUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

certificateId

string

Identifier of the certificate entity. Must be unique in the current API Management service instance.

parameters
CertificateCreateOrUpdateParameters

Create or Update parameters.

options
CertificateCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CertificateCreateOrUpdateResponse>

delete(string, string, string, string, CertificateDeleteOptionalParams)

Deletes specific certificate.

function delete(resourceGroupName: string, serviceName: string, certificateId: string, ifMatch: string, options?: CertificateDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

certificateId

string

Identifier of the certificate entity. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options
CertificateDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, CertificateGetOptionalParams)

Gets the details of the certificate specified by its identifier.

function get(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetOptionalParams): Promise<CertificateGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

certificateId

string

Identifier of the certificate entity. Must be unique in the current API Management service instance.

options
CertificateGetOptionalParams

The options parameters.

Returns

Promise<CertificateGetResponse>

getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the certificate specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetEntityTagOptionalParams): Promise<CertificateGetEntityTagHeaders>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

certificateId

string

Identifier of the certificate entity. Must be unique in the current API Management service instance.

options
CertificateGetEntityTagOptionalParams

The options parameters.

Returns

Promise<CertificateGetEntityTagHeaders>

listByService(string, string, CertificateListByServiceOptionalParams)

Lists a collection of all certificates in the specified service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: CertificateListByServiceOptionalParams): PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options
CertificateListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>

refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)

From KeyVault, Refresh the certificate being used for authentication with the backend.

function refreshSecret(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateRefreshSecretOptionalParams): Promise<CertificateRefreshSecretResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

certificateId

string

Identifier of the certificate entity. Must be unique in the current API Management service instance.

options
CertificateRefreshSecretOptionalParams

The options parameters.

Returns

Promise<CertificateRefreshSecretResponse>