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://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificatesを参照してください。
$select	query		string	OData $select 句。
maxresults	query		integer int32	応答で返される項目の最大数。最大 1,000 個の証明書を返すことができます。
timeout	query		integer int32	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。値が 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 を直接呼び出す場合は、明示的に設定します。

応答

名前	型	説明
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
Authorization URL (承認 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 桁の 16 進数のシーケンスです。
thumbprintAlgorithm	string	拇印の派生に使用されるアルゴリズム。
url	string	証明書の URL。

CertificateListResult

アカウントに証明書を一覧表示した結果。

名前	型	説明
odata.nextLink	string	次の結果セットを取得する URL。
value	Certificate[]	証明書の一覧。

CertificateState

証明書の状態。

名前	型	説明
active	string	証明書はプールで使用できます。
deletefailed	string	ユーザーは証明書の削除を要求しましたが、証明書への参照が残っているプールがあるか、1 つ以上のノードにインストールされているプールがあります。 (後者は、証明書がプールから削除されているが、コンピューティングノードがまだ再起動されていない場合に発生する可能性があります。コンピューティングノードは、再起動時にのみ証明書を更新します)。証明書の削除の取り消し操作を使用して削除を取り消すか、削除を再試行する証明書の削除操作を使用できます。
deleting	string	ユーザーは証明書の削除を要求しましたが、削除操作はまだ完了していません。プールの作成時または更新時に証明書を参照することはできません。

DeleteCertificateError

証明書を削除するときに Batch サービスで発生したエラー。

名前	型	説明
code	string	証明書の削除エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
message	string	ユーザーインターフェイスでの表示に適した証明書の削除エラーを説明するメッセージ。
values	NameValuePair[]	証明書の削除エラーに関連する追加エラーの詳細の一覧。この一覧には、この証明書を参照するアクティブなプールやコンピューティングノードなどの詳細が含まれています。ただし、多数のリソースが証明書を参照している場合、リストに含まれるのは最初の 100 個程度のみです。

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

その他のリソース