Nodes - List Node Extensions
指定されたプール内の計算ノード拡張を一覧にします。
GET {endpoint}/pools/{poolId}/nodes/{nodeId}/extensions?api-version=2025-06-01
GET {endpoint}/pools/{poolId}/nodes/{nodeId}/extensions?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$select={$select}
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Batch アカウント エンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。 |
|
node
|
path | True |
string |
拡張をリストしたいComputeノードのIDです。 |
|
pool
|
path | True |
string |
Compute Nodeを含むプールのIDです。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
|
$select
|
query |
string[] |
OData $select 句。 |
|
|
maxresults
|
query |
integer (int32) minimum: 1maximum: 1000 |
応答で返される項目の最大数。 最大1000件の申請書を返送できます。 |
|
|
time
|
query |
integer (int32) |
サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が30より大きい場合は、デフォルトが使われます。」 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| client-request-id |
string |
呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。 |
|
| return-client-request-id |
boolean |
サーバーが応答で client-request-id を返す必要があるかどうか。 |
|
| ocp-date |
string (date-time-rfc7231) |
要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は成功しました。 ヘッダー
|
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
OAuth2Auth
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ
| 名前 | 説明 |
|---|---|
| https://batch.core.windows.net//.default |
例
List compute node extensions
要求のサンプル
GET {endpoint}/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z/extensions?api-version=2025-06-01
応答のサンプル
{
"value": [
{
"instanceView": {
"name": "batchNodeExtension",
"statuses": [
{
"code": "ProvisioningState/succeeded",
"level": "Info",
"displayStatus": "Provisioning succeeded",
"message": "Enable succeeded: Enabling and starting agent and controller"
}
]
},
"vmExtension": {
"name": "batchNodeExtension",
"publisher": "Microsoft.Azure.Extensions",
"type": "CustomScript",
"typeHandlerVersion": "2.0",
"autoUpgradeMinorVersion": true
}
},
{
"instanceView": {
"name": "customExtension",
"statuses": [
{
"code": "ProvisioningState/succeeded",
"level": "Info",
"displayStatus": "Provisioning succeeded",
"message": "ExtensionOperation:enable. Status:Success"
}
]
},
"vmExtension": {
"name": "customExtension",
"publisher": "Microsoft.Azure.Geneva",
"type": "GenevaMonitoring",
"typeHandlerVersion": "2.0",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true
}
}
]
}
定義
| 名前 | 説明 |
|---|---|
|
Batch |
Azure Batch サービスから受信したエラー応答。 |
|
Batch |
Azure Batch エラー応答に含まれる追加情報の項目。 |
|
Batch |
Azure Batch エラー応答で受信したエラー メッセージ。 |
|
Batch |
仮想マシン拡張機能インスタンス ビューの構成。 |
|
Batch |
ノード内のコンピューティング ノード拡張機能を一覧表示した結果。 |
|
Instance |
インスタンス ビューの状態。 |
|
Status |
レベルコード。 |
| VMExtension |
仮想マシン拡張機能の構成。 |
|
VMExtension |
VM 拡張機能インスタンス ビュー。 |
BatchError
Azure Batch サービスから受信したエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
| message |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
|
| values |
エラーに関する追加の詳細を含むキーと値のペアのコレクション。 |
BatchErrorDetail
Azure Batch エラー応答に含まれる追加情報の項目。
| 名前 | 型 | 説明 |
|---|---|---|
| key |
string |
Value プロパティの意味を指定する識別子。 |
| value |
string |
エラー応答に含まれる追加情報。 |
BatchErrorMessage
Azure Batch エラー応答で受信したエラー メッセージ。
| 名前 | 型 | 説明 |
|---|---|---|
| lang |
string |
エラーメッセージの言語コード。 |
| value |
string |
メッセージのテキスト。 |
BatchNodeVMExtension
仮想マシン拡張機能インスタンス ビューの構成。
| 名前 | 型 | 説明 |
|---|---|---|
| instanceView |
VM 拡張機能インスタンス ビュー。 |
|
| provisioningState |
string |
仮想マシン拡張のプロビジョニング状態。 |
| vmExtension |
仮想マシン拡張です。 |
BatchNodeVMExtensionListResult
ノード内のコンピューティング ノード拡張機能を一覧表示した結果。
| 名前 | 型 | 説明 |
|---|---|---|
| odata.nextLink |
string (uri) |
次の結果セットを取得するための URL。 |
| value |
Compute Node拡張のリスト。 |
InstanceViewStatus
インスタンス ビューの状態。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
状態コード。 |
| displayStatus |
string |
ステータスのローカライズされたラベル。 |
| level |
レベルコード。 |
|
| message |
string |
詳細なステータスメッセージ。 |
| time |
string (date-time) |
状態の時刻。 |
StatusLevelTypes
レベルコード。
| 値 | 説明 |
|---|---|
| Error |
エラー |
| Info |
Info |
| Warning |
Warnung |
VMExtension
仮想マシン拡張機能の構成。
| 名前 | 型 | 説明 |
|---|---|---|
| autoUpgradeMinorVersion |
boolean |
展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。 |
| enableAutomaticUpgrade |
boolean |
使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。 |
| name |
string |
仮想マシン拡張機能の名前。 |
| protectedSettings |
object |
拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 |
| provisionAfterExtensions |
string[] |
拡張機能名のコレクション。 この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 |
| publisher |
string |
拡張ハンドラーの発行元の名前。 |
| settings |
object |
拡張機能の JSON 形式のパブリック設定。 |
| type |
string |
拡張機能の種類。 |
| typeHandlerVersion |
string |
スクリプト ハンドラーのバージョン。 |
VMExtensionInstanceView
VM 拡張機能インスタンス ビュー。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
VM拡張インスタンスビューの名前です。 |
| statuses |
リソースの状態情報。 |
|
| subStatuses |
リソースの状態情報。 |