Account - List Supported Images
Azure Batch サービスでサポートされているすべての仮想マシン イメージを一覧表示します。
GET {batchUrl}/supportedimages?api-version=2024-07-01.20.0
GET {batchUrl}/supportedimages?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
batch
|
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-support-imagesを参照してください。 |
|
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 |
サポートされている仮想マシン イメージの一覧を含む応答。 ヘッダー
|
|
Other Status Codes |
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
例
Account list node agent skus
要求のサンプル
GET account.region.batch.azure.com/supportedimages?api-version=2024-07-01.20.0
応答のサンプル
{
"value": [
{
"nodeAgentSKUId": "batch.node.centos 7",
"imageReference": {
"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.2",
"version": "latest"
},
"verificationType": "verified",
"capabilities": [
"DockerCompatible",
"NvidiaTeslaDriverInstalled"
],
"osType": "linux"
},
{
"nodeAgentSKUId": "batch.node.centos 7",
"imageReference": {
"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.1",
"version": "latest"
},
"verificationType": "unverified",
"osType": "linux",
"batchSupportEndOfLife": "2019-11-01T00:00:00.0Z"
},
{
"nodeAgentSKUId": "batch.node.debian 8",
"imageReference": {
"publisher": "Credativ",
"offer": "Debian",
"sku": "8",
"version": "latest"
},
"verificationType": "verified",
"osType": "linux"
},
{
"nodeAgentSKUId": "batch.node.windows amd64",
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2012-R2-Datacenter",
"version": "latest"
},
"verificationType": "verified",
"osType": "windows"
},
{
"nodeAgentSKUId": "batch.node.windows amd64",
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2012-Datacenter",
"version": "latest"
},
"verificationType": "verified",
"osType": "windows"
}
]
}
定義
名前 | 説明 |
---|---|
Account |
サポートされている仮想マシン イメージを一覧表示した結果。 |
Batch |
Azure Batch サービスから受信したエラー応答。 |
Batch |
Azure Batch エラー応答に含まれる追加情報の項目。 |
Error |
Azure Batch エラー応答で受信したエラー メッセージ。 |
Image |
Azure Virtual Machines Marketplace イメージへの参照と、イメージに関する追加情報。 |
Image |
Azure Virtual Machines Marketplace イメージまたは Azure コンピューティング ギャラリー イメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。 |
OSType |
イメージのオペレーティング システムの種類 (Windows や Linux など)。 |
Verification |
Azure Batch サービスが、イメージが関連付けられているコンピューティング ノード エージェント SKU と互換性があることをアクティブに検証するかどうか。 |
AccountListSupportedImagesResult
サポートされている仮想マシン イメージを一覧表示した結果。
名前 | 型 | 説明 |
---|---|---|
odata.nextLink |
string |
次の結果セットを取得する URL。 |
value |
サポートされている仮想マシン イメージの一覧。 |
BatchError
Azure Batch サービスから受信したエラー応答。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
message |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
|
values |
エラーに関する追加の詳細を含むキーと値のペアのコレクション。 |
BatchErrorDetail
Azure Batch エラー応答に含まれる追加情報の項目。
名前 | 型 | 説明 |
---|---|---|
key |
string |
Value プロパティの意味を指定する識別子。 |
value |
string |
エラー応答に含まれる追加情報。 |
ErrorMessage
Azure Batch エラー応答で受信したエラー メッセージ。
名前 | 型 | 説明 |
---|---|---|
lang |
string |
エラー メッセージの言語コード |
value |
string |
メッセージのテキスト。 |
ImageInformation
Azure Virtual Machines Marketplace イメージへの参照と、イメージに関する追加情報。
名前 | 型 | 説明 |
---|---|---|
batchSupportEndOfLife |
string |
Azure Batch サービスがイメージに対するプールの作成要求の受け入れを停止する時刻。 |
capabilities |
string[] |
イメージがサポートする機能。 |
imageReference |
Azure 仮想マシンの Marketplace イメージへの参照。 |
|
nodeAgentSKUId |
string |
イメージがサポートするコンピューティング ノード エージェント SKU の ID。 |
osType |
イメージのオペレーティング システムの種類 (Windows や Linux など)。 |
|
verificationType |
Azure Batch サービスが、イメージが関連付けられているコンピューティング ノード エージェント SKU と互換性があることをアクティブに検証するかどうか。 |
ImageReference
Azure Virtual Machines Marketplace イメージまたは Azure コンピューティング ギャラリー イメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。
名前 | 型 | 説明 |
---|---|---|
communityGalleryImageId |
string |
コミュニティ ギャラリー イメージの一意識別子 |
exactVersion |
string |
ノードの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージの特定のバージョン。 この読み取り専用フィールドは、プールの作成時に 'version' に指定された値が 'latest' の場合にのみ、'version' と異なります。 |
offer |
string |
Azure Virtual Machines Marketplace イメージのオファーの種類。 |
publisher |
string |
Azure Virtual Machines Marketplace イメージの発行元。 |
sharedGalleryImageId |
string |
共有ギャラリー イメージの一意識別子 |
sku |
string |
Azure Virtual Machines Marketplace イメージの SKU。 |
version |
string |
Azure Virtual Machines Marketplace イメージのバージョン。 |
virtualMachineImageId |
string |
Azure コンピューティング ギャラリー イメージの ARM リソース識別子。 プール内のコンピューティング ノードは、このイメージ ID を使用して作成されます。これは、常に最新のイメージ バージョンに既定値を設定するために、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{subscriptionId}/resourceGroup}/providers/Microsoft.Compute/galleryName}/images/{imageDefinitionName} の形式です。 |
OSType
イメージのオペレーティング システムの種類 (Windows や Linux など)。
名前 | 型 | 説明 |
---|---|---|
linux |
string |
Linux オペレーティング システム。 |
windows |
string |
Windows オペレーティング システム。 |
VerificationType
Azure Batch サービスが、イメージが関連付けられているコンピューティング ノード エージェント SKU と互換性があることをアクティブに検証するかどうか。
名前 | 型 | 説明 |
---|---|---|
unverified |
string |
関連付けられているコンピューティング ノード エージェント SKU は、イメージとのバイナリ互換性を持っている必要がありますが、特定の機能は検証されていません。 |
verified |
string |
イメージは、関連付けられているコンピューティング ノード エージェント SKU と互換性があることを保証され、すべての Batch 機能が期待どおりに動作することが確認されています。 |