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

Certificate - List By Service

参考

服务:: API Management

API 版本:: 2024-05-01

列出指定服务实例中所有证书的集合。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates?api-version=2024-05-01

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates?$filter={$filter}&$top={$top}&$skip={$skip}&isKeyVaultRefreshFailed={isKeyVaultRefreshFailed}&api-version=2024-05-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。
$filter	query		string	\|字段 \|用法 \|支持的运算符 \|支持的函数 \| \|-------------\|-------------\|-------------\|-------------\| \|name \|filter \|ge， le， eq， ne， gt， lt \|substringof， contains， startswith， endswith \| \|subject \|filter \|ge， le， eq， ne， gt， lt \|substringof， contains， startswith， endswith \| \|指纹 \|filter \|ge， le， eq， ne， gt， lt \|substringof， contains， startswith， endswith \| \|expirationDate \|filter \|ge， le， eq， ne， gt， lt \| \|
$skip	query		integer (int32) minimum: 0	要跳过的记录数。
$top	query		integer (int32) minimum: 1	要返回的记录数。
isKeyVaultRefreshFailed	query		boolean	设置为 true 时，响应仅包含失败刷新的证书实体。

响应

名称	类型	说明
200 OK	CertificateCollection	返回 Certificate 实体的集合。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementListCertificates

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates?api-version=2024-05-01

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/kjoshiarmtemplateCert1",
      "type": "Microsoft.ApiManagement/service/certificates",
      "name": "templateCert1",
      "properties": {
        "subject": "CN=mutual-authcert",
        "thumbprint": "EBA************************48594A6",
        "expirationDate": "2017-04-23T17:03:41Z"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
      "type": "Microsoft.ApiManagement/service/certificates",
      "name": "templateCertkv",
      "properties": {
        "subject": "CN=*.msitesting.net",
        "thumbprint": "EA**********************9AD690",
        "expirationDate": "2037-01-01T07:00:00Z",
        "keyVault": {
          "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
          "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
          "lastStatus": {
            "code": "Success",
            "timeStampUtc": "2020-09-22T00:24:53.3191468Z"
          }
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

定义

名称	说明
CertificateCollection	分页证书列表表示形式。
CertificateContract	证书详细信息。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
KeyVaultContractProperties	KeyVault 合同详细信息。
KeyVaultLastAccessStatusContractProperties	发出协定更新属性。

CertificateCollection

Object

分页证书列表表示形式。

名称	类型	说明
count	integer (int64)	所有页面的总记录计数数。
nextLink	string	下一页链接（如果有）。
value	CertificateContract[]	页面值。

CertificateContract

Object

证书详细信息。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.expirationDate	string (date-time)	证书的到期日期。日期符合以下格式：按 ISO 8601 标准指定的 `yyyy-MM-ddTHH:mm:ssZ`。
properties.keyVault	KeyVaultContractProperties	证书的 KeyVault 位置详细信息。
properties.subject	string	证书的使用者属性。
properties.thumbprint	string	证书的指纹。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

KeyVaultContractProperties

Object

KeyVault 合同详细信息。

名称	类型	说明
identityClientId	string	SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的客户端 ID，用于访问密钥保管库机密。
lastStatus	KeyVaultLastAccessStatusContractProperties	上次从密钥保管库同步和刷新机密的状态。
secretIdentifier	string	用于提取机密的密钥保管库机密标识符。提供版本控制机密将阻止自动刷新。这要求使用 aka.ms/apimmsi 配置 API 管理服务

KeyVaultLastAccessStatusContractProperties

Object

发出协定更新属性。

名称	类型	说明
code	string	用于从密钥保管库同步和刷新机密的最后状态代码。
message	string	错误的详细信息，否则为空。
timeStampUtc	string (date-time)	上次访问机密的时间。日期符合以下格式：按 ISO 8601 标准指定的 `yyyy-MM-ddTHH:mm:ssZ`。

通过

Certificate - List By Service

URI 参数

响应

安全性

azure_auth

作用域

示例

ApiManagementListCertificates

示例请求

示例响应

定义

CertificateCollection

CertificateContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

其他资源