Compute Node Extension - List

Referenz

Dienst:: Batch Service

API-Version:: 2024-07-01.20.0

Listet die Computeknotenerweiterungen im angegebenen Pool auf.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/extensions?api-version=2024-07-01.20.0

Mit optionalen Parametern:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/extensions?$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
nodeId	path	True	string	Die ID des Computeknotens, den Sie auflisten möchten.
poolId	path	True	string	Die ID des Pools, der Computeknoten enthält.
api-version	query	True	string	Client-API-Version.
$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 Computeknoten können zurückgegeben 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. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

Anforderungsheader

Media Types: "application/json; odata=minimalmetadata"

Name	Typ	Beschreibung
client-request-id	string (uuid)	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-rfc1123)	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	NodeVMExtensionList	Eine Antwort, die die Liste der Computeknoten enthält. Header client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batchdienst.

Name

Typ

Beschreibung

200 OK

NodeVMExtensionList

Eine Antwort, die die Liste der Computeknoten enthält.

Header

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

Other Status Codes

BatchError

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

List compute node extensions

Beispielanforderung

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z/extensions?api-version=2024-07-01.20.0

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.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
InstanceViewStatus	Der Status der Instanzansicht.
NodeVMExtension	Die Konfiguration für die Ansicht der Erweiterungsinstanz für virtuelle Computer.
NodeVMExtensionList	Das Ergebnis der Auflistung der Computeknotenerweiterungen in einem Knoten.
StatusLevelTypes	Ebenencode.
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	ErrorMessage	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.

ErrorMessage

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 Meldung.

InstanceViewStatus

Objekt

Der Status der Instanzansicht.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die lokalisierte Bezeichnung für den Status.
level	StatusLevelTypes	Ebenencode.
message	string	Die detaillierte Statusmeldung.
time	string	Die Uhrzeit des Status.

NodeVMExtension

Objekt

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

Name	Typ	Beschreibung
instanceView	VMExtensionInstanceView	Die Vm-Erweiterungsinstanzansicht.
provisioningState	string	Der Bereitstellungsstatus der Erweiterung des virtuellen Computers.
vmExtension	VMExtension	Die Erweiterung des virtuellen Computers

NodeVMExtensionList

Objekt

Das Ergebnis der Auflistung der Computeknotenerweiterungen in einem Knoten.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value	NodeVMExtension[]	Die Liste der Computeknotenerweiterungen.

StatusLevelTypes

Enumeration

Ebenencode.

Wert	Beschreibung
Error
Info
Warning

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	Der Typ der Erweiterung.
typeHandlerVersion	string	Die Version des Skripthandlers.

VMExtensionInstanceView

Objekt

Die Vm-Erweiterungsinstanzansicht.

Name	Typ	Beschreibung
name	string	Der Name der Vm-Erweiterungsinstanzansicht.
statuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.
subStatuses	InstanceViewStatus[]	Die Ressourcenstatusinformationen.

Freigeben über

Compute Node Extension - List

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Authorization

Beispiele

List compute node extensions

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchError

BatchErrorDetail

ErrorMessage

InstanceViewStatus

NodeVMExtension

NodeVMExtensionList

StatusLevelTypes

VMExtension

VMExtensionInstanceView