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

Certificate - Get

获取有关指定证书的信息。
警告:此操作已弃用,将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展

GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?api-version=2023-11-01.18.0
GET {batchUrl}/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})?$select={$select}&timeout={timeout}&api-version=2023-11-01.18.0

URI 参数

名称 必需 类型 说明
batchUrl
path True

string

所有Azure Batch服务请求的基 URL。

thumbprint
path True

string

要获取的证书的指纹。

thumbprintAlgorithm
path True

string

用于派生指纹参数的算法。 这必须是 sha1。

api-version
query True

string

客户端 API 版本。

$select
query

string

OData $select 子句。

timeout
query

integer

int32

服务器可以花费处理请求的最长时间(以秒为单位)。 默认为 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

Certificate

包含证书的响应。

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称 说明
user_impersonation 模拟用户帐户

Authorization

Type: apiKey
In: header

示例

Certificate get

Sample Request

GET account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)?api-version=2023-11-01.18.0


Sample Response

{
  "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

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

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。

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

名称/值对中的值。