你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。

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>