Certificate - Add

Service:

Batch Service

API Version:

2023-11-01.18.0

指定したアカウントに証明書を追加します。
警告: この操作は非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。

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

With optional parameters:

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	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない 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 でエンコードされた内容。 最大サイズは 10 KB です。
thumbprint	True	string	証明書の X.509 拇印。 これは最大 40 桁の 16 進数字のシーケンスです (スペースを含めることができますが、これらは削除されます)。
thumbprintAlgorithm	True	string	拇印の派生に使用されるアルゴリズム。 これは sha1 である必要があります。
certificateFormat		CertificateFormat	証明書データの形式。
password		string	証明書の秘密キーにアクセスするためのパスワード。 証明書の形式が cer の場合は、これを省略する必要があります。

応答

名前	型	説明
201 Created		Batch サービスへの要求が成功しました。 Headers 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 認証コード フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

Authorization

Type: apiKey
In: header

例

Certificate add

Sample Request

HTTP

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



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

Sample Response

Status code:

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 でエンコードされた内容。 最大サイズは 10 KB です。
password	string	証明書の秘密キーにアクセスするためのパスワード。 証明書の形式が cer の場合は、これを省略する必要があります。
thumbprint	string	証明書の X.509 拇印。 これは最大 40 桁の 16 進数字のシーケンスです (スペースを含めることができますが、これらは削除されます)。
thumbprintAlgorithm	string	拇印の派生に使用されるアルゴリズム。 これは sha1 である必要があります。

CertificateFormat

証明書データの形式。

名前	型	説明
cer	string	証明書は、base64 でエンコードされた X.509 証明書です。
pfx	string	証明書は PFX (PKCS#12) 形式の証明書または証明書チェーンです。

ErrorMessage

Azure Batchエラー応答で受信したエラー メッセージ。

名前	型	説明
lang	string	エラー メッセージの言語コード
value	string	メッセージのテキストです。