CertificateImpl | @azure/arm-apimanagement

Class containing Certificate operations.

Hierarchy

CertificateImpl

Implements

Certificate

Index

Constructors

constructor

Methods

Constructors

constructor

new CertificateImpl(client: ApiManagementClientContext): CertificateImpl

- Defined in operations/certificate.ts:36
Initialize a new instance of the class Certificate class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns CertificateImpl

Methods

createOrUpdate

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

Implementation of Certificate.createOrUpdate
- Defined in operations/certificate.ts:183
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>

Implementation of Certificate.delete
- Defined in operations/certificate.ts:206
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>

Implementation of Certificate.get
- Defined in operations/certificate.ts:162
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>

Implementation of Certificate.getEntityTag
- Defined in operations/certificate.ts:142
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>

Implementation of Certificate.listByService
- Defined in operations/certificate.ts:52
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>

Implementation of Certificate.refreshSecret
- Defined in operations/certificate.ts:227
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

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns CertificateImpl

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>