Nodes - List Node Extensions

服務:: Batch Service

API 版本:: 2025-06-01

列出指定池中計算節點的擴充。

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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	Batch 帳戶端點（例如：https://batchaccount.eastus2.batch.azure.com）。
nodeId	path	True	string	你想列出擴充功能的運算節點的 ID。
poolId	path	True	string	包含運算節點的池的 ID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。
$select	query		string[]	OData $select 子句。
maxresults	query		integer (int32) minimum: 1 maximum: 1000	回應中要傳回的項目數目上限。最多可提交1000份申請。
timeOut	query		integer (int32)	伺服器可以花費數秒處理要求的時間上限。預設值為 30 秒。若值大於30，則會使用預設值。」

要求標頭

名稱	類型	Description
client-request-id	string	呼叫端產生的要求身分識別，格式為 GUID，不含大括弧，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id	boolean	伺服器是否應該在回應中傳回 client-request-id。
ocp-date	string (date-time-rfc7231)	發出要求的時間。用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。

回應

名稱	類型	Description
200 OK	BatchNodeVMExtensionListResult	要求已成功。標題 ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	未預期的錯誤回應。

名稱

類型

Description

200 OK

BatchNodeVMExtensionListResult

要求已成功。

標題

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

範圍

名稱	Description
https://batch.core.windows.net//.default

範例

List compute node extensions

範例要求

HTTP

GET {endpoint}/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z/extensions?api-version=2025-06-01

範例回覆

狀態碼:: 200

{
  "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
      }
    }
  ]
}

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
BatchErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。
BatchNodeVMExtension	虛擬機擴充實例檢視的組態。
BatchNodeVMExtensionListResult	列出節點中計算節點延伸模組的結果。
InstanceViewStatus	實例檢視狀態。
StatusLevelTypes	關卡代碼。
VMExtension	虛擬機延伸模組的組態。
VMExtensionInstanceView	vm 擴充實例檢視。

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

BatchErrorMessage

Object

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

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

BatchNodeVMExtension

Object

虛擬機擴充實例檢視的組態。

名稱	類型	Description
instanceView	VMExtensionInstanceView	vm 擴充實例檢視。
provisioningState	string	虛擬機擴充的配置狀態。
vmExtension	VMExtension	虛擬機器擴充功能。

BatchNodeVMExtensionListResult

Object

列出節點中計算節點延伸模組的結果。

名稱	類型	Description
odata.nextLink	string (uri)	取得下一組結果的 URL。
value	BatchNodeVMExtension[]	計算節點擴充列表。

InstanceViewStatus

Object

實例檢視狀態。

名稱	類型	Description
code	string	狀態代碼。
displayStatus	string	這是狀態的在地標籤。
level	StatusLevelTypes	關卡代碼。
message	string	詳細的狀態訊息。
time	string (date-time)	狀態的時間。

StatusLevelTypes

列舉型別

關卡代碼。

值	Description
Error	錯誤
Info	Info
Warning	警告

VMExtension

Object

虛擬機延伸模組的組態。

名稱	類型	Description
autoUpgradeMinorVersion	boolean	指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。
enableAutomaticUpgrade	boolean	指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。
name	string	虛擬機擴充功能的名稱。
protectedSettings	object	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。
provisionAfterExtensions	string[]	延伸模組名稱的集合。必須布建此延伸模組之後的延伸模組名稱集合。
publisher	string	擴充處理程序發行者的名稱。
settings	object	擴充功能的 JSON 格式化公用設定。
type	string	分機的類型。
typeHandlerVersion	string	腳本處理程式的版本。

VMExtensionInstanceView

Object

vm 擴充實例檢視。

名稱	類型	Description
name	string	虛擬機擴充實例檢視的名稱。
statuses	InstanceViewStatus[]	資源狀態資訊。
subStatuses	InstanceViewStatus[]	資源狀態資訊。

共用方式為

Nodes - List Node Extensions

URI 參數

要求標頭

回應

安全性

OAuth2Auth

範圍

範例

List compute node extensions

範例要求

範例回覆

定義

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeVMExtension

BatchNodeVMExtensionListResult

InstanceViewStatus

StatusLevelTypes

VMExtension

VMExtensionInstanceView