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

Certificate - Add

服务:

Batch Service

API 版本:

2023-11-01.18.0

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

POST {batchUrl}/certificates?api-version=2023-11-01.18.0

具有可选参数:

POST {batchUrl}/certificates?timeout={timeout}&api-version=2023-11-01.18.0

URI 参数

名称	在	必需	类型	说明
batchUrl	path	True	string	所有Azure Batch服务请求的基 URL。
api-version	query	True	string	客户端 API 版本。
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，请显式设置它。

请求正文

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

名称	必需	类型	说明
data	True	string	证书的 base64 编码内容。 最大大小为 10KB。
thumbprint	True	string	证书的 X.509 指纹。 这是一个最多 40 个十六进制数字的序列， (它可能包含空格，但这些数字) 删除。
thumbprintAlgorithm	True	string	用于派生指纹的算法。 这必须是 sha1。
certificateFormat		CertificateFormat	证书数据的格式。
password		string	用于访问证书私钥的密码。 如果证书格式为 cer，则必须省略这一点。

响应

名称	类型	说明
201 Created		对 Batch 服务的请求已成功。 标头 client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: 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 add

示例请求

HTTP

POST account.region.batch.azure.com/certificates?api-version=2023-11-01.18.0



{
  "thumbprintAlgorithm": "sha1",
  "thumbprint": "0123456789abcdef0123456789abcdef01234567",
  "data": "#####...",
  "certificateFormat": "pfx",
  "password": "<ExamplePassword>"
}

示例响应

状态代码:

201

定义

名称	说明
BatchError	从Azure Batch服务收到的错误响应。
BatchErrorDetail	Azure Batch错误响应中包含的其他信息项。
CertificateAddParameter	一个证书，可以安装在计算节点上，并可用于对计算机上的操作进行身份验证。
CertificateFormat	证书数据的格式。
ErrorMessage	Azure Batch错误响应中收到的错误消息。

BatchError

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

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

BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。

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

CertificateAddParameter

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

名称	类型	说明
certificateFormat	CertificateFormat	证书数据的格式。
data	string	证书的 base64 编码内容。 最大大小为 10KB。
password	string	用于访问证书私钥的密码。 如果证书格式为 cer，则必须省略这一点。
thumbprint	string	证书的 X.509 指纹。 这是一个最多 40 个十六进制数字的序列， (它可能包含空格，但这些数字) 删除。
thumbprintAlgorithm	string	用于派生指纹的算法。 这必须是 sha1。

CertificateFormat

证书数据的格式。

名称	类型	说明
cer	string	证书是 base64 编码的 X.509 证书。
pfx	string	证书是 PFX (PKCS#12) 格式化的证书或证书链。

ErrorMessage

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

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