Nodes - List Node Extensions

Dienst:: Batch Service

API-Version:: 2025-06-01

listet die Compute Nodes-Erweiterungen im angegebenen Pool auf.

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/extensions?api-version=2025-06-01

Mit optionalen Parametern:

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/extensions?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$select={$select}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Batchkontoendpunkt (z. B. https://batchaccount.eastus2.batch.azure.com).
nodeId	path	True	string	Die ID des Compute-Knotens, mit dem Sie Erweiterungen auflisten möchten.
poolId	path	True	string	Die ID des Pools, der den Rechenknoten enthält.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$select	query		string[]	Eine OData-$select-Klausel.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Maximal 1000 Anträge können zurückgeschickt werden.
timeOut	query		integer (int32)	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Ist der Wert größer als 30, wird stattdessen der Standard verwendet."

Anforderungsheader

Name	Typ	Beschreibung
client-request-id	string	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date	string (date-time-rfc7231)	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	BatchNodeVMExtensionListResult	Die Anforderung ist erfolgreich. Header ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

BatchNodeVMExtensionListResult

Die Anforderung ist erfolgreich.

Header

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

Other Status Codes

BatchError

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
https://batch.core.windows.net//.default

Beispiele

List compute node extensions

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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
      }
    }
  ]
}

Definitionen

Name	Beschreibung
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
BatchErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
BatchNodeVMExtension	Die Konfiguration für die Ansicht der Erweiterungsinstanz für virtuelle Computer.
BatchNodeVMExtensionListResult	Das Ergebnis der Auflistung der Computeknotenerweiterungen in einem Knoten.
InstanceViewStatus	Der Status der Instanzansicht.
StatusLevelTypes	Level-Code.
VMExtension	Die Konfiguration für Erweiterungen virtueller Computer.
VMExtensionInstanceView	Die Vm-Erweiterungsinstanzansicht.

BatchError

Objekt

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message	BatchErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Objekt

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.

Name	Typ	Beschreibung
key	string	Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value	string	Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

BatchErrorMessage

Objekt

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung.
value	string	Der Text der Nachricht.

BatchNodeVMExtension

Objekt

Die Konfiguration für die Ansicht der Erweiterungsinstanz für virtuelle Computer.

Name	Typ	Beschreibung
instanceView	VMExtensionInstanceView	Die Vm-Erweiterungsinstanzansicht.
provisioningState	string	Der Bereitstellungszustand der virtuellen Maschinenerweiterung.
vmExtension	VMExtension	Die virtuelle Maschinen-Erweiterung.

BatchNodeVMExtensionListResult

Objekt

Das Ergebnis der Auflistung der Computeknotenerweiterungen in einem Knoten.

Name	Typ	Beschreibung
odata.nextLink	string (uri)	Die URL zum Abrufen der nächsten Ergebnisse.
value	BatchNodeVMExtension[]	Die Liste der Compute Node-Erweiterungen.

InstanceViewStatus

Objekt

Der Status der Instanzansicht.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die lokalisierte Bezeichnung für den Status.
level	StatusLevelTypes	Level-Code.
message	string	Die detaillierte Statusnachricht.
time	string (date-time)	Die Uhrzeit des Status.

StatusLevelTypes

Enumeration

Level-Code.

Wert	Beschreibung
Error	Fehler
Info	Info
Warning	Warnung

VMExtension

Objekt

Die Konfiguration für Erweiterungen virtueller Computer.

Name	Typ	Beschreibung
autoUpgradeMinorVersion	boolean	Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Nach der Bereitstellung aktualisiert die Erweiterung jedoch keine Nebenversionen, es sei denn, sie werden erneut bereitgestellt, auch wenn diese Eigenschaft auf "true" festgelegt ist.
enableAutomaticUpgrade	boolean	Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.
name	string	Der Name der Erweiterung des virtuellen Computers.
protectedSettings	object	Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten.
provisionAfterExtensions	string[]	Die Sammlung von Erweiterungsnamen. Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss.
publisher	string	Der Name des Herausgebers des Erweiterungshandlers.
settings	object	JSON-formatierte öffentliche Einstellungen für die Erweiterung.
type	string	Die Art der Verlängerung.
typeHandlerVersion	string	Die Version des Skripthandlers.

VMExtensionInstanceView

Objekt

Die Vm-Erweiterungsinstanzansicht.

Name	Typ	Beschreibung
name	string	Der Name der VM-Erweiterungs-Instanzansicht.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
subStatuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.

Freigeben über

Nodes - List Node Extensions

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

OAuth2Auth

Bereiche

Beispiele

List compute node extensions

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeVMExtension

BatchNodeVMExtensionListResult

InstanceViewStatus

StatusLevelTypes

VMExtension

VMExtensionInstanceView