Certificate | @azure/arm-apimanagement

Interface representing a Certificate.

Hierarchy

Certificate

Implemented by

CertificateImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/certificate.ts:76
Creates or updates the certificate being used for authentication with the backend.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: CertificateCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<CertificateCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/certificate.ts:93
Deletes specific certificate.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: CertificateDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/certificate.ts:61
Gets the details of the certificate specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: CertificateGetOptionalParams
  
  The options parameters.
Returns Promise<CertificateGetResponse>

getEntityTag

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

- Defined in operationsInterfaces/certificate.ts:47
Gets the entity state (Etag) version of the certificate specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: CertificateGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<CertificateGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: CertificateListByServiceOptionalParams): PagedAsyncIterableIterator<CertificateContract>

- Defined in operationsInterfaces/certificate.ts:34
Lists a collection of all certificates in the specified service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: CertificateListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CertificateContract>

refreshSecret

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

- Defined in operationsInterfaces/certificate.ts:108
From KeyVault, Refresh the certificate being used for authentication with the backend.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: CertificateRefreshSecretOptionalParams
  
  The options parameters.
Returns Promise<CertificateRefreshSecretResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

certificateId: string

parameters: CertificateCreateOrUpdateParameters

Optional options: CertificateCreateOrUpdateOptionalParams

Returns Promise<CertificateCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

certificateId: string

ifMatch: string

Optional options: CertificateDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

certificateId: string

Optional options: CertificateGetOptionalParams

Returns Promise<CertificateGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

certificateId: string

Optional options: CertificateGetEntityTagOptionalParams

Returns Promise<CertificateGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: CertificateListByServiceOptionalParams

Returns PagedAsyncIterableIterator<CertificateContract>

refreshSecret

Parameters

resourceGroupName: string

serviceName: string

certificateId: string

Optional options: CertificateRefreshSecretOptionalParams

Returns Promise<CertificateRefreshSecretResponse>