共用方式為

Certificate interface

  • 參考
套件:
@azure/arm-apimanagement

表示憑證的介面。

方法

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

建立或更新用於向後端進行驗證的憑證。
delete(string, string, string, string, CertificateDeleteOptionalParams)

刪除特定憑證。
get(string, string, string, CertificateGetOptionalParams)

取得其標識碼所指定之憑證的詳細數據。
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)

取得其標識碼所指定憑證的實體狀態 （Etag） 版本。
listByService(string, string, CertificateListByServiceOptionalParams)

列出指定服務實例中所有憑證的集合。
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)

從 KeyVault，重新整理要用於向後端進行驗證的憑證。

方法詳細資料

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

建立或更新用於向後端進行驗證的憑證。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

certificateId

string

憑證實體的標識碼。 目前 API 管理服務實例中必須是唯一的。

parameters
CertificateCreateOrUpdateParameters

建立或更新參數。

options
CertificateCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<CertificateCreateOrUpdateResponse>

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

刪除特定憑證。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

certificateId

string

憑證實體的標識碼。 目前 API 管理服務實例中必須是唯一的。

ifMatch

string

實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。

options
CertificateDeleteOptionalParams

選項參數。

傳回

Promise<void>

get(string, string, string, CertificateGetOptionalParams)

取得其標識碼所指定之憑證的詳細數據。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

certificateId

string

憑證實體的標識碼。 目前 API 管理服務實例中必須是唯一的。

options
CertificateGetOptionalParams

選項參數。

傳回

Promise<CertificateGetResponse>

getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)

取得其標識碼所指定憑證的實體狀態 （Etag） 版本。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

certificateId

string

憑證實體的標識碼。 目前 API 管理服務實例中必須是唯一的。

options
CertificateGetEntityTagOptionalParams

選項參數。

傳回

Promise<CertificateGetEntityTagHeaders>

listByService(string, string, CertificateListByServiceOptionalParams)

列出指定服務實例中所有憑證的集合。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

options
CertificateListByServiceOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>

refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)

從 KeyVault，重新整理要用於向後端進行驗證的憑證。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

certificateId

string

憑證實體的標識碼。 目前 API 管理服務實例中必須是唯一的。

options
CertificateRefreshSecretOptionalParams

選項參數。

傳回

Promise<CertificateRefreshSecretResponse>