Certificate - Add

服務:

Batch Service

API 版本:

2024-07-01.20.0

將憑證新增至指定的帳戶。
警告：這項作業已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能。

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

含選擇性參數:

POST {batchUrl}/certificates?timeout={timeout}&api-version=2024-07-01.20.0

URI 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
api-version	query	True	string	用戶端 API 版本。
timeout	query		integer int32	伺服器可以花費數秒處理要求的時間上限。 預設值為30秒。 如果值大於 30，則會改用預設值。

要求標頭

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

名稱	必要	類型	Description
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"

名稱	必要	類型	Description
data	True	string	憑證的base64編碼內容。 大小上限為 10KB。
thumbprint	True	string	憑證的 X.509 指紋。 這是最多 40 個十六進位數位的序列（它可能包含空格，但會移除這些數位）。
thumbprintAlgorithm	True	string	用來衍生指紋的演算法。 這必須是sha1。
certificateFormat		CertificateFormat	憑證數據的格式。
password		string	存取憑證私鑰的密碼。 如果憑證格式為 cer，則必須省略此專案。

回應

名稱	類型	Description
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
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

Authorization

類型: apiKey
位於: header

範例

Certificate add

範例要求

HTTP

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



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

範例回覆

狀態碼:

201

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
CertificateAddParameter	可在計算節點上安裝的憑證，可用來驗證計算機上的作業。
CertificateFormat	憑證數據的格式。
ErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。

BatchError

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message	ErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應隨附的其他資訊。

CertificateAddParameter

可在計算節點上安裝的憑證，可用來驗證計算機上的作業。

名稱	類型	Description
certificateFormat	CertificateFormat	憑證數據的格式。
data	string	憑證的base64編碼內容。 大小上限為 10KB。
password	string	存取憑證私鑰的密碼。 如果憑證格式為 cer，則必須省略此專案。
thumbprint	string	憑證的 X.509 指紋。 這是最多 40 個十六進位數位的序列（它可能包含空格，但會移除這些數位）。
thumbprintAlgorithm	string	用來衍生指紋的演算法。 這必須是sha1。

CertificateFormat

憑證數據的格式。

名稱	類型	Description
cer	string	憑證是base64編碼的 X.509 憑證。
pfx	string	憑證是 PFX （PKCS#12） 格式化的憑證或憑證鏈結。

ErrorMessage

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼
value	string	訊息的文字。