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

Certificate - List

参考

服务:: Batch Service

API 版本:: 2024-07-01.20.0

列出已添加到指定帐户的所有证书。
警告：此操作已弃用，将在 2024 年 2 月之后删除。请改用 Azure KeyVault 扩展。

GET {batchUrl}/certificates?api-version=2024-07-01.20.0

具有可选参数:

GET {batchUrl}/certificates?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI 参数

名称	在	必需	类型	说明
batchUrl	path	True	string	所有 Azure Batch 服务请求的基本 URL。
api-version	query	True	string	客户端 API 版本。
$filter	query		string	OData $filter 子句。有关构造此筛选器的详细信息，请参阅 https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificates。
$select	query		string	OData $select 子句。
maxresults	query		integer int32	响应中要返回的最大项数。最多可以返回 1000 个证书。
timeout	query		integer int32	服务器处理请求的最长时间（以秒为单位）。默认值为 30 秒。如果该值大于 30，则改用默认值。

请求头

Media Types: "application/json; odata=minimalmetadata"

名称	类型	说明
client-request-id	string uuid	调用方生成的请求标识，采用不带大括号的 GUID 形式，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id	boolean	服务器是否应在响应中返回 client-request-id。
ocp-date	string date-time-rfc1123	发出请求的时间。客户端库通常将此设置为当前的系统时钟时间;如果直接调用 REST API，请显式设置它。

响应

名称	类型	说明
200 OK	CertificateListResult	包含证书列表的响应。标头 client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 服务中的错误。

名称

类型

说明

200 OK

CertificateListResult

包含证书列表的响应。

标头

client-request-id: string
request-id: string
ETag: string
Last-Modified: string

Other Status Codes

BatchError

Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

Authorization

类型: apiKey
在: header

示例

Certificate list

示例请求

HTTP

GET account.region.batch.azure.com/certificates?api-version=2024-07-01.20.0

示例响应

状态代码:: 200

{
  "value": [
    {
      "thumbprint": "0123456789abcdef0123456789abcdef01234567",
      "thumbprintAlgorithm": "sha1",
      "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)",
      "state": "deletefailed",
      "stateTransitionTime": "2014-07-31T21:12:58.236Z",
      "previousState": "deleting",
      "previousStateTransitionTime": "2014-07-31T21:11:58.236Z",
      "publicData": "#####...",
      "deleteCertificateError": {
        "code": "PoolsReferencingCertificate",
        "message": "The specified certificate is being used by the below mentioned pool(s)",
        "values": [
          {
            "name": "Pools",
            "value": "mypool1"
          }
        ]
      }
    }
  ]
}

定义

名称	说明
BatchError	从 Azure Batch 服务收到的错误响应。
BatchErrorDetail	Azure Batch 错误响应中包含的附加信息项。
Certificate	可在计算节点上安装的证书，可用于对计算机上的操作进行身份验证。
CertificateListResult	列出帐户中的证书的结果。
CertificateState	证书的状态。
DeleteCertificateError	删除证书时 Batch 服务遇到的错误。
ErrorMessage	Azure Batch 错误响应中收到的错误消息。
NameValuePair	表示名称/值对。

BatchError

从 Azure Batch 服务收到的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
message	ErrorMessage	描述错误的消息，旨在适合在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的更多详细信息的键值对的集合。

BatchErrorDetail

Azure Batch 错误响应中包含的附加信息项。

名称	类型	说明
key	string	指定 Value 属性含义的标识符。
value	string	错误响应附带的其他信息。

Certificate

可在计算节点上安装的证书，可用于对计算机上的操作进行身份验证。

名称	类型	说明
deleteCertificateError	DeleteCertificateError	上次尝试删除此证书时发生的错误。仅当证书处于 DeleteFailed 状态时，才会设置此属性。
previousState	CertificateState	证书的上一状态。如果证书处于初始活动状态，则不会设置此属性。
previousStateTransitionTime	string	证书进入其上一状态的时间。如果证书处于初始活动状态，则不会设置此属性。
publicData	string	证书的公共部分是 base-64 编码.cer文件。
state	CertificateState	证书的当前状态。
stateTransitionTime	string	证书进入其当前状态的时间。
thumbprint	string	证书的 X.509 指纹。这是最多 40 个十六进制数字的序列。
thumbprintAlgorithm	string	用于派生指纹的算法。
url	string	证书的 URL。

CertificateListResult

列出帐户中的证书的结果。

名称	类型	说明
odata.nextLink	string	用于获取下一组结果的 URL。
value	Certificate[]	证书列表。

CertificateState

证书的状态。

名称	类型	说明
active	string	证书可用于池。
deletefailed	string	用户请求删除证书，但有一些池仍具有对证书的引用，或者它仍安装在一个或多个节点上。（如果证书已从池中删除，但计算节点尚未重启，则可能会出现后者。计算节点仅在重启时刷新其证书。可以使用取消证书删除操作来取消删除或删除证书操作，以重试删除。
deleting	string	用户已请求删除证书，但删除操作尚未完成。创建或更新池时，不能引用证书。

DeleteCertificateError

删除证书时 Batch 服务遇到的错误。

名称	类型	说明
code	string	证书删除错误的标识符。代码是固定的，旨在以编程方式使用。
message	string	描述证书删除错误的消息，旨在适合在用户界面中显示。
values	NameValuePair[]	与证书删除错误相关的其他错误详细信息的列表。此列表包括引用此证书的活动池和计算节点等详细信息。但是，如果大量资源引用证书，则列表仅包含大约第一百个。

ErrorMessage

Azure Batch 错误响应中收到的错误消息。

名称	类型	说明
lang	string	错误消息的语言代码
value	string	消息的文本。

NameValuePair

表示名称/值对。

名称	类型	说明
name	string	名称值对中的名称。
value	string	名称值对中的值。

通过

Certificate - List

URI 参数

请求头

响应

安全性

azure_auth

作用域

Authorization

示例

Certificate list

示例请求

示例响应

定义

BatchError

BatchErrorDetail

Certificate

CertificateListResult

CertificateState

DeleteCertificateError

ErrorMessage

NameValuePair

其他资源