BatchClient class
Client-Klasse zum Zugriff auf Azure Batch Service.
Konstruktoren
| Batch |
Methoden
| create |
Der Batch-Service unterstützt zwei Möglichkeiten, die im Rahmen eines Auftrags verrichteter Arbeit zu steuern. Im ersten Ansatz gibt der Benutzer eine Jobmanager-Aufgabe an. Der Batch-Service startet diese Aufgabe, wenn er bereit ist, den Job zu starten. Die Job Manager Task steuert alle anderen Tasks, die unter diesem Job laufen, über die Task-APIs. Im zweiten Ansatz steuert der Benutzer direkt die Ausführung von Aufgaben unter einem aktiven Job durch die Nutzung der Aufgaben-APIs. Beachten Sie auch: Vermeiden Sie bei der Benennung von Jobs sensible Informationen wie Benutzernamen oder geheime Projektnamen. Diese Informationen können in Telemetrieprotokollen erscheinen, die für Microsoft-Support-Ingenieure zugänglich sind. |
| create |
Erstellt einen Jobplan für das angegebene Konto. |
| create |
Man kann ein Benutzerkonto einem Compute-Node nur dann hinzufügen, wenn er sich im Leerlauf oder im laufenden Zustand befindet. Bevor Sie sich aus der Ferne bei einem Compute-Node anmelden können, müssen Sie Zugriffsportarten für SSH und RDP konfigurieren. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/batch/pool-endpoint-configuration |
| create |
Vermeiden Sie beim Benennen von Pools vertrauliche Informationen wie Benutzernamen oder geheime Projektnamen. Diese Informationen können in Telemetrieprotokollen erscheinen, die für Microsoft-Support-Ingenieure zugänglich sind. |
| create |
Die maximale Lebensdauer einer Aufgabe von der Ergänzung bis zum Abschluss beträgt 180 Tage. Wenn eine Aufgabe nicht innerhalb von 180 Tagen nach Hinzufügen abgeschlossen wurde, wird sie vom Batch-Service beendet und in dem Zustand zurückgelassen, in dem sie sich zu diesem Zeitpunkt befand. |
| create |
Beachte, dass jede Aufgabe eine eindeutige ID haben muss. Der Batch-Service kann die Ergebnisse für jede Aufgabe nicht in derselben Reihenfolge zurückgeben, in der die Aufgaben in dieser Anfrage eingereicht wurden. Wenn der Server abläuft oder die Verbindung während der Anfrage geschlossen wird, kann die Anfrage teilweise oder vollständig bearbeitet worden sein oder gar nicht. In solchen Fällen sollte der Nutzer die Anfrage erneut senden. Beachten Sie, dass es am Benutzer liegt, Fehler beim erneuten Senden einer Anfrage korrekt zu handhaben. Zum Beispiel sollten Sie während eines erneuten Versuchs dieselben Task-IDs verwenden, sodass, falls die vorherige Operation erfolgreich war, der Versuch nicht unerwartet zusätzliche Aufgaben erzeugt. Wenn die Antwort Aufgaben enthält, die nicht hinzugefügt werden konnten, kann ein Client die Anfrage erneut versuchen. Bei einem erneuten Versuch ist es am effizientesten, nur Aufgaben erneut einzureichen, die nicht hinzugefügt wurden, und Aufgaben auszulassen, die beim ersten Versuch erfolgreich hinzugefügt wurden. Die maximale Lebensdauer einer Aufgabe von der Ergänzung bis zum Abschluss beträgt 180 Tage. Wenn eine Aufgabe nicht innerhalb von 180 Tagen nach Hinzufügen abgeschlossen wurde, wird sie vom Batch-Service beendet und in dem Zustand zurückgelassen, in dem sie sich zu diesem Zeitpunkt befand. |
| deallocate |
Sie können die Zuordnung eines Computeknotens nur durchführen, wenn er sich in einem Leerlauf- oder Ausführungszustand befindet. |
| delete |
Das Löschen eines Jobs löscht außerdem alle Aufgaben, die Teil dieses Jobs sind, sowie alle Job-Statistiken. Dies überschreibt auch die Aufbewahrungszeit für Aufgabendaten; das heißt, wenn der Job Tasks enthält, die noch auf Compute Nodes gespeichert sind, löschen die Batch-Services die Arbeitsverzeichnisse dieser Tasks und alle deren Inhalte. Wenn eine Lösch-Job-Anfrage eingegangen ist, setzt der Batch-Service den Job auf den Lösch-Zustand. Alle Aktualisierungsoperationen an einem Job, der sich im Löschzustand befindet, schlagen mit Statuscode 409 (Konflikt) fehl, wobei zusätzliche Informationen anzeigen, dass der Job gelöscht wird. |
| delete |
Wenn Sie einen Auftragsplan löschen, löscht dies auch alle Aufträge und Vorgänge unter diesem Zeitplan. Wenn Aufgaben gelöscht werden, werden alle Dateien in ihren Arbeitsverzeichnissen auf den Computeknoten ebenfalls gelöscht (der Aufbewahrungszeitraum wird ignoriert). Auf die Auftragsplanungsstatistiken kann nicht mehr zugegriffen werden, nachdem der Auftragsplan gelöscht wurde, obwohl sie weiterhin in die Statistiken zur Kontolebensdauer gezählt werden. |
| delete |
Löscht die angegebene Datei aus dem Computeknoten. |
| delete |
Sie können ein Benutzerkonto nur dann in einem Computeknoten löschen, wenn es sich im Leerlauf- oder Ausführungszustand befindet. Bevor Sie sich aus der Ferne bei einem Compute-Node anmelden können, müssen Sie Zugriffsportarten für SSH und RDP konfigurieren. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/batch/pool-endpoint-configuration |
| delete |
Wenn Sie anfordern, dass ein Pool gelöscht wird, treten die folgenden Aktionen auf: Der Poolstatus ist auf das Löschen festgelegt; alle laufenden Größenänderungsvorgänge im Pool werden beendet; Der Batchdienst startet die Größenänderung des Pools auf null Computeknoten; alle Aufgaben, die auf vorhandenen Computeknoten ausgeführt werden, werden beendet und erneut abgefragt (als ob ein Vorgang zur Größenänderung mit der Standardoption für die erneute Warteschlange angefordert wurde); schließlich wird der Pool aus dem System entfernt. Da die Ausführung von Aufgaben erneut abgefragt wird, kann der Benutzer diese Aufgaben erneut ausführen, indem er seinen Auftrag auf einen anderen Pool aktualisiert. Die Aufgaben können dann im neuen Pool ausgeführt werden. Wenn Sie das Verhalten der erneuten Warteschlange außer Kraft setzen möchten, sollten Sie die Größe des Pools explizit aufrufen, um die Größe des Pools auf null zu verkleinern, bevor Sie den Pool löschen. Wenn Sie eine Update-, Patch- oder Delete-API für einen Pool im Löschzustand aufrufen, schlägt sie mit dem HTTP-Statuscode 409 mit dem Fehlercode PoolBeingDeleted fehl. |
| delete |
Wenn eine Aufgabe gelöscht wird, werden alle Dateien im Verzeichnis des Computeknotens, in dem sie ausgeführt wurde, ebenfalls gelöscht (unabhängig von der Aufbewahrungszeit). Bei Vorgängen mit mehreren Instanzen gilt der Vorgangslöschvorgang synchron für den primären Vorgang. Teilvorgänge und deren Dateien werden dann asynchron im Hintergrund gelöscht. |
| delete |
Löscht die angegebene Vorgangsdatei aus dem Computeknoten, in dem die Aufgabe ausgeführt wurde. |
| disable |
Der Batch-Service versetzt den Job sofort in den Zustand der Funktionsfähigkeit (Deaktivieren). Batch verwendet dann den Parameter disableTasks, um zu bestimmen, was mit den aktuell laufenden Aufgaben des Jobs geschehen soll. Der Job bleibt im Deaktivierungszustand, bis die Deaktivierungsoperation abgeschlossen ist und alle Aufgaben gemäß der DisableTasks-Option erledigt wurden; der Job wechselt dann in den behinderten Zustand. Unter dem Job werden keine neuen Aufgaben gestartet, bis er wieder in den aktiven Zustand zurückkehrt. Wenn du versuchst, einen Job zu deaktivieren, der sich in einem anderen Zustand als aktiv, deaktivierend oder deaktiviert befindet, schlägt die Anfrage mit Statuscode 409 fehl. |
| disable |
Es werden keine neuen Aufträge erstellt, bis der Auftragsplan erneut aktiviert ist. |
| disable |
Man kann die Aufgabenplanung auf einem Compute-Knoten nur deaktivieren, wenn dessen aktueller Planungszustand aktiviert ist. |
| disable |
Deaktiviert die automatische Skalierung für einen Pool. |
| enable |
Wenn Sie diese API aufrufen, setzt der Batch-Service einen deaktivierten Job auf den aktivierten Zustand. Nach Abschluss dieser Operation wechselt der Job in den aktiven Zustand, und die Planung neuer Aufgaben unter dem Job wird fortgesetzt. Der Batch-Dienst erlaubt es nicht, dass eine Aufgabe länger als 180 Tage im aktiven Zustand bleibt. Wenn Sie also einen Job aktivieren, der aktive Aufgaben enthält, die vor mehr als 180 Tagen hinzugefügt wurden, werden diese Aufgaben nicht ausgeführt. |
| enable |
Aktiviert einen Auftragsplan. |
| enable |
Man kann die Task-Scheduling auf einem Compute-Node nur aktivieren, wenn dessen aktueller Planungszustand deaktiviert ist |
| enable |
Sie können die automatische Skalierung für einen Pool nicht aktivieren, wenn ein Vorgang zum Ändern der Größe im Pool ausgeführt wird. Wenn die automatische Skalierung des Pools derzeit deaktiviert ist, müssen Sie eine gültige Autoskalenformel als Teil der Anforderung angeben. Wenn die automatische Skalierung des Pools bereits aktiviert ist, können Sie eine neue Autoskalenformel und/oder ein neues Auswertungsintervall angeben. Sie können diese API nicht für denselben Pool mehr als einmal alle 30 Sekunden aufrufen. |
| evaluate |
Diese API dient in erster Linie zum Validieren einer Autoskalenformel, da sie einfach das Ergebnis zurückgibt, ohne die Formel auf den Pool anzuwenden. Der Pool muss die automatische Skalierung aktiviert haben, um eine Formel auszuwerten. |
| get |
Diese Operation liefert nur Anwendungen und Versionen zurück, die für die Nutzung auf Compute Nodes verfügbar sind; das heißt, das kann in einer Paketreferenz verwendet werden. Für Administratorinformationen zu Anwendungen und Versionen, die den Compute Nodes noch nicht zur Verfügung stehen, verwenden Sie das Azure-Portal oder die Azure Resource Manager API. |
| get |
Erhält Informationen über den angegebenen Auftrag. |
| get |
Erhält Informationen über den angegebenen Arbeitsplan. |
| get |
Aufgabenanzahlen stellen eine Anzahl der Aufgaben nach aktivem, ausgeführtem oder abgeschlossenem Vorgangsstatus und einer Anzahl von Aufgaben bereit, die erfolgreich waren oder fehlgeschlagen sind. Aufgaben im Vorbereitungszustand werden als ausgeführt gezählt. Beachten Sie, dass die zurückgegebenen Zahlen möglicherweise nicht immer auf dem neuesten Stand sind. Wenn Sie genaue Vorgangsanzahlen benötigen, verwenden Sie eine Listenabfrage. |
| get |
Ruft Informationen zum angegebenen Computeknoten ab. |
| get |
Erhält Informationen über die angegebene Compute Node Extension. |
| get |
Gibt den Inhalt der angegebenen Compute-Node-Datei zurück. |
| get |
Ruft die Eigenschaften der angegebenen Computeknotendatei ab. |
| get |
Bevor Sie sich mit den Remote-Login-Einstellungen aus der Ferne bei einem Compute-Node anmelden können, müssen Sie ein Benutzerkonto auf dem Compute-Node erstellen und Zugriffsportarten für SSH und RDP konfigurieren. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/batch/pool-endpoint-configuration |
| get |
Ruft Informationen zum angegebenen Pool ab. |
| get |
Für Multi-Instanz-Aufgaben beziehen sich Informationen wie affinityId, executionInfo und nodeInfo auf die primäre Aufgabe. Verwenden Sie die Liste der Unteraufgaben-API, um Informationen über Unteraufgaben abzurufen. |
| get |
Gibt den Inhalt der angegebenen Task-Datei zurück. |
| get |
Ruft die Eigenschaften der angegebenen Vorgangsdatei ab. |
| job |
Überprüft, ob der angegebene Arbeitsplan existiert. |
| list |
Diese Operation liefert nur Anwendungen und Versionen zurück, die für die Nutzung auf Compute Nodes verfügbar sind; das heißt, das kann in einer Paketreferenz verwendet werden. Für Administratorinformationen zu Anwendungen und Versionen, die den Compute Nodes noch nicht zur Verfügung stehen, verwenden Sie das Azure-Portal oder die Azure Resource Manager API. |
| list |
Diese API gibt den Auftragsvorbereitungs- und Auftragsveröffentlichungsvorgangsstatus für alle Computeknoten zurück, die die Aufgabe "Auftragsvorbereitung" oder "Auftragsfreigabe" ausgeführt haben. Dazu gehören Computeknoten, die seitdem aus dem Pool entfernt wurden. Wenn diese API für einen Auftrag aufgerufen wird, der keine Auftragsvorbereitungs- oder Auftragsfreigabeaufgabe enthält, gibt der Batchdienst DEN HTTP-Statuscode 409 (Conflict) mit einem Fehlercode von JobPreparationTaskNotSpecified zurück. |
| list |
Listet alle Jobs im angegebenen Konto auf. |
| list |
Listet alle Jobpläne im angegebenen Konto auf. |
| list |
Listet die Jobs auf, die unter dem angegebenen Jobplan erstellt wurden. |
| list |
listet die Compute Nodes-Erweiterungen im angegebenen Pool auf. |
| list |
Listet alle Dateien in Aufgabenverzeichnissen auf dem angegebenen Computeknoten auf. |
| list |
Listet die Computeknoten im angegebenen Pool auf. |
| list |
Ruft die Anzahl der Computeknoten in jedem Zustand ab, gruppiert nach Pool. Beachten Sie, dass die zurückgegebenen Zahlen möglicherweise nicht immer auf dem neuesten Stand sind. Wenn Sie genaue Knotenanzahl benötigen, verwenden Sie eine Listenabfrage. |
| list |
Listet alle Pools im angegebenen Konto auf. |
| list |
Wenn Sie keine $filter Klausel einschließlich einer poolId angeben, enthält die Antwort alle Pools, die im Konto im Zeitraum der zurückgegebenen Aggregationsintervalle vorhanden sind. Wenn Sie keine $filter Klausel angeben, die eine startTime- oder EndTime-Klausel enthält, werden diese Filter standardmäßig auf die Start- und Endzeiten des letzten verfügbaren Aggregationsintervalls festgelegt. d. h., nur das letzte Aggregationsintervall wird zurückgegeben. |
| list |
Wenn die Aufgabe kein Vorgang mit mehreren Instanzen ist, gibt dies eine leere Auflistung zurück. |
| list |
Listet alle vom Azure Batch-Dienst unterstützten images für virtuelle Computer auf. |
| list |
Listet die Dateien im Verzeichnis einer Aufgabe auf dem Computeknoten auf. |
| list |
Für Multi-Instanz-Aufgaben beziehen sich Informationen wie affinityId, executionInfo und nodeInfo auf die primäre Aufgabe. Verwenden Sie die Liste der Unteraufgaben-API, um Informationen über Unteraufgaben abzurufen. |
| pool |
Erhält grundlegende Eigenschaften eines Pools. |
| reactivate |
Durch die Reaktivierung kann ein Vorgang bis zur maximalen Wiederholungsanzahl erneut wiederholt werden. Der Status des Vorgangs wird in "aktiv" geändert. Da sich der Vorgang nicht mehr im Status "Abgeschlossen" befindet, sind alle vorherigen Beendigungscode- oder Fehlerinformationen nach der Reaktivierung nicht mehr verfügbar. Jedes Mal, wenn eine Aufgabe reaktiviert wird, wird die Wiederholungsanzahl auf 0 zurückgesetzt. Die Reaktivierung schlägt für Vorgänge fehl, die nicht abgeschlossen wurden oder die zuvor erfolgreich abgeschlossen wurden (mit einem Exitcode von 0). Darüber hinaus tritt ein Fehler auf, wenn der Auftrag abgeschlossen ist (oder beendet oder gelöscht wird). |
| reboot |
Sie können einen Computeknoten nur neu starten, wenn er sich in einem Leerlauf- oder Ausführungszustand befindet. |
| reimage |
Sie können das Betriebssystem nur dann auf einem Computeknoten neu installieren, wenn es sich in einem Leerlauf- oder Ausführungszustand befindet. Diese API kann nur auf Pools aufgerufen werden, die mit der Cloud-Service-Konfigurationseigenschaft erstellt wurden. |
| remove |
Dieser Vorgang kann nur ausgeführt werden, wenn der Zuordnungsstatus des Pools stabil ist. Wenn dieser Vorgang ausgeführt wird, ändert sich der Zuordnungsstatus von stetig in Größenänderung. Jede Anforderung kann bis zu 100 Knoten entfernen. |
| replace |
Dies ersetzt vollständig alle aktualisierbaren Eigenschaften des Jobs. Zum Beispiel, wenn der Job mit Einschränkungen verbunden ist und keine Einschränkungen mit dieser Anfrage angegeben sind, entfernt der Batch-Service die bestehenden Einschränkungen. |
| replace |
Dies ersetzt vollständig alle aktualisierbaren Eigenschaften des Jobplans. Wenn zum Beispiel die Schedule-Eigenschaft mit dieser Anfrage nicht angegeben ist, entfernt der Batch-Service den bestehenden Schedule. Änderungen an einem Jobplan betreffen nur Jobs, die nach der Aktualisierung durch den Dienstplan erstellt werden; derzeit laufende Jobs sind unbeeinträchtigt. |
| replace |
Diese Operation ersetzt alle aktualisierten Eigenschaften des Kontos. Wenn zum Beispiel das Element expiryTime nicht angegeben ist, wird der aktuelle Wert durch den Standardwert ersetzt und nicht unverändert gelassen. Man kann ein Benutzerkonto auf einem Compute-Node nur aktualisieren, wenn er sich im Leerlauf oder im laufenden Zustand befindet. |
| replace |
Dies ersetzt vollständig alle aktualisierbaren Eigenschaften des Pools. Zum Beispiel, wenn der Pool eine StartTask zugeordnet hat und StartTask mit dieser Anfrage nicht angegeben ist, entfernt der Batch-Service den bestehenden StartTask. |
| replace |
Aktualisiert die Eigenschaften der angegebenen Task. |
| resize |
Sie können die Größe eines Pools nur ändern, wenn der Zuordnungszustand stabil ist. Wenn die Größe des Pools bereits geändert wird, schlägt die Anforderung mit dem Statuscode 409 fehl. Wenn Sie die Größe eines Pools ändern, ändert sich der Zuordnungsstatus des Pools von stetig zur Größenänderung. Sie können die Größe von Pools, die für die automatische Skalierung konfiguriert sind, nicht ändern. Wenn Sie versuchen, dies zu tun, gibt der Batchdienst einen Fehler 409 zurück. Wenn Sie die Größe eines Pools nach unten ändern, wählt der Batchdienst aus, welche Computeknoten entfernt werden sollen. Verwenden Sie zum Entfernen bestimmter Computeknoten stattdessen die Computeknoten-API des Pools. |
| start |
Man kann einen Compute-Node nur dann starten, wenn er bereits ausgeräumt wurde. |
| stop |
Dies stellt den Pool nicht in seinen vorherigen Zustand vor der Größenänderung zurück: Es verhindert nur weitere Änderungen, und der Pool behält seinen aktuellen Zustand bei. Nach dem Stoppen stabilisiert sich der Pool auf der Anzahl der Rechenknoten, bei der er sich zum Zeitpunkt der Stoppoperation befand. Während des Stoppbetriebs ändert sich der Zuweisungszustand des Pools zunächst zu stoppend und dann zu stationär. Eine Resize-Operation muss keine explizite Resize-Pool-Anfrage sein; diese API kann auch verwendet werden, um die anfängliche Größe des Pools beim Erstellen zu stoppen. |
| terminate |
Wenn eine Anfrage zum Beenden des Jobs eingeht, setzt der Batch-Service den Job auf den Terminationszustand. Der Batch-Service beendet dann alle laufenden Tasks, die mit dem Job verknüpft sind, und führt alle erforderlichen Job-Release-Aufgaben aus. Dann wechselt der Job in den abgeschlossenen Zustand. Wenn es Aufgaben im aktiven Zustand im Job gibt, bleiben sie im aktiven Zustand. Sobald ein Job beendet ist, können keine neuen Aufgaben hinzugefügt werden und verbleibende aktive Aufgaben werden nicht geplant. |
| terminate |
Beendet einen Auftragsplan. |
| terminate |
Wenn die Aufgabe beendet wurde, wird sie in den Status "Abgeschlossen" verschoben. Bei Vorgängen mit mehreren Instanzen gilt der Vorgang zum Beenden des Vorgangs synchron für den primären Vorgang. Teilvorgänge werden dann asynchron im Hintergrund beendet. |
| update |
Dies ersetzt nur die in der Anfrage angegebenen Job-Eigenschaften. Wenn zum Beispiel der Job Einschränkungen hat und eine Anfrage das Element der Einschränkungen nicht angibt, behält der Auftrag die bestehenden Einschränkungen. |
| update |
Dies ersetzt nur die in der Anfrage angegebenen Job Schedule-Eigenschaften. Wenn zum Beispiel die Schedule-Eigenschaft mit dieser Anfrage nicht angegeben ist, behält der Batch-Service den bestehenden Schedule. Änderungen an einem Jobplan betreffen nur Jobs, die nach der Aktualisierung durch den Dienstplan erstellt werden; derzeit laufende Jobs sind unbeeinträchtigt. |
| update |
Dies ersetzt nur die in der Anfrage angegebenen Pool-Eigenschaften. Wenn zum Beispiel der Pool eine StartTask zugeordnet hat und eine Anfrage kein StartTask-Element angibt, behält der Pool das bestehende StartTask. |
| upload |
Dies dient dazu, Azure Batch-Service-Logdateien automatisiert von Compute Nodes zu sammeln, falls Sie einen Fehler haben und an den Azure-Support eskalieren möchten. Die Azure Batch Dienstprotokolldateien sollten für Azure-Support freigegeben werden, um Fehler beim Debuggen mit dem Batchdienst zu unterstützen. |
Details zum Konstruktor
BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)
new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)Parameter
- endpointParam
-
string
- credential
- options
- BatchClientOptionalParams
Details zur Methode
createJob(BatchJobCreateOptions, CreateJobOptionalParams)
Der Batch-Service unterstützt zwei Möglichkeiten, die im Rahmen eines Auftrags verrichteter Arbeit zu steuern. Im ersten Ansatz gibt der Benutzer eine Jobmanager-Aufgabe an. Der Batch-Service startet diese Aufgabe, wenn er bereit ist, den Job zu starten. Die Job Manager Task steuert alle anderen Tasks, die unter diesem Job laufen, über die Task-APIs. Im zweiten Ansatz steuert der Benutzer direkt die Ausführung von Aufgaben unter einem aktiven Job durch die Nutzung der Aufgaben-APIs. Beachten Sie auch: Vermeiden Sie bei der Benennung von Jobs sensible Informationen wie Benutzernamen oder geheime Projektnamen. Diese Informationen können in Telemetrieprotokollen erscheinen, die für Microsoft-Support-Ingenieure zugänglich sind.
function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>Parameter
- options
- CreateJobOptionalParams
Gibt zurück
Promise<void>
createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)
Erstellt einen Jobplan für das angegebene Konto.
function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>Parameter
- jobSchedule
- BatchJobScheduleCreateOptions
- options
- CreateJobScheduleOptionalParams
Gibt zurück
Promise<void>
createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)
Man kann ein Benutzerkonto einem Compute-Node nur dann hinzufügen, wenn er sich im Leerlauf oder im laufenden Zustand befindet. Bevor Sie sich aus der Ferne bei einem Compute-Node anmelden können, müssen Sie Zugriffsportarten für SSH und RDP konfigurieren. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>Parameter
- poolId
-
string
- nodeId
-
string
- options
- CreateNodeUserOptionalParams
Gibt zurück
Promise<void>
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)
Vermeiden Sie beim Benennen von Pools vertrauliche Informationen wie Benutzernamen oder geheime Projektnamen. Diese Informationen können in Telemetrieprotokollen erscheinen, die für Microsoft-Support-Ingenieure zugänglich sind.
function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>Parameter
- options
- CreatePoolOptionalParams
Gibt zurück
Promise<void>
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)
Die maximale Lebensdauer einer Aufgabe von der Ergänzung bis zum Abschluss beträgt 180 Tage. Wenn eine Aufgabe nicht innerhalb von 180 Tagen nach Hinzufügen abgeschlossen wurde, wird sie vom Batch-Service beendet und in dem Zustand zurückgelassen, in dem sie sich zu diesem Zeitpunkt befand.
function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>Parameter
- jobId
-
string
- options
- CreateTaskOptionalParams
Gibt zurück
Promise<void>
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)
Beachte, dass jede Aufgabe eine eindeutige ID haben muss. Der Batch-Service kann die Ergebnisse für jede Aufgabe nicht in derselben Reihenfolge zurückgeben, in der die Aufgaben in dieser Anfrage eingereicht wurden. Wenn der Server abläuft oder die Verbindung während der Anfrage geschlossen wird, kann die Anfrage teilweise oder vollständig bearbeitet worden sein oder gar nicht. In solchen Fällen sollte der Nutzer die Anfrage erneut senden. Beachten Sie, dass es am Benutzer liegt, Fehler beim erneuten Senden einer Anfrage korrekt zu handhaben. Zum Beispiel sollten Sie während eines erneuten Versuchs dieselben Task-IDs verwenden, sodass, falls die vorherige Operation erfolgreich war, der Versuch nicht unerwartet zusätzliche Aufgaben erzeugt. Wenn die Antwort Aufgaben enthält, die nicht hinzugefügt werden konnten, kann ein Client die Anfrage erneut versuchen. Bei einem erneuten Versuch ist es am effizientesten, nur Aufgaben erneut einzureichen, die nicht hinzugefügt wurden, und Aufgaben auszulassen, die beim ersten Versuch erfolgreich hinzugefügt wurden. Die maximale Lebensdauer einer Aufgabe von der Ergänzung bis zum Abschluss beträgt 180 Tage. Wenn eine Aufgabe nicht innerhalb von 180 Tagen nach Hinzufügen abgeschlossen wurde, wird sie vom Batch-Service beendet und in dem Zustand zurückgelassen, in dem sie sich zu diesem Zeitpunkt befand.
function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>Parameter
- jobId
-
string
- taskCollection
- BatchTaskGroup
Gibt zurück
Promise<BatchCreateTaskCollectionResult>
deallocateNode(string, string, DeallocateNodeOptionalParams)
Sie können die Zuordnung eines Computeknotens nur durchführen, wenn er sich in einem Leerlauf- oder Ausführungszustand befindet.
function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>Parameter
- poolId
-
string
- nodeId
-
string
- options
- DeallocateNodeOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
deleteJob(string, DeleteJobOptionalParams)
Das Löschen eines Jobs löscht außerdem alle Aufgaben, die Teil dieses Jobs sind, sowie alle Job-Statistiken. Dies überschreibt auch die Aufbewahrungszeit für Aufgabendaten; das heißt, wenn der Job Tasks enthält, die noch auf Compute Nodes gespeichert sind, löschen die Batch-Services die Arbeitsverzeichnisse dieser Tasks und alle deren Inhalte. Wenn eine Lösch-Job-Anfrage eingegangen ist, setzt der Batch-Service den Job auf den Lösch-Zustand. Alle Aktualisierungsoperationen an einem Job, der sich im Löschzustand befindet, schlagen mit Statuscode 409 (Konflikt) fehl, wobei zusätzliche Informationen anzeigen, dass der Job gelöscht wird.
function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>Parameter
- jobId
-
string
- options
- DeleteJobOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)
Wenn Sie einen Auftragsplan löschen, löscht dies auch alle Aufträge und Vorgänge unter diesem Zeitplan. Wenn Aufgaben gelöscht werden, werden alle Dateien in ihren Arbeitsverzeichnissen auf den Computeknoten ebenfalls gelöscht (der Aufbewahrungszeitraum wird ignoriert). Auf die Auftragsplanungsstatistiken kann nicht mehr zugegriffen werden, nachdem der Auftragsplan gelöscht wurde, obwohl sie weiterhin in die Statistiken zur Kontolebensdauer gezählt werden.
function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>Parameter
- jobScheduleId
-
string
- options
- DeleteJobScheduleOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)
Löscht die angegebene Datei aus dem Computeknoten.
function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>Parameter
- poolId
-
string
- nodeId
-
string
- filePath
-
string
- options
- DeleteNodeFileOptionalParams
Gibt zurück
Promise<void>
deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)
Sie können ein Benutzerkonto nur dann in einem Computeknoten löschen, wenn es sich im Leerlauf- oder Ausführungszustand befindet. Bevor Sie sich aus der Ferne bei einem Compute-Node anmelden können, müssen Sie Zugriffsportarten für SSH und RDP konfigurieren. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>Parameter
- poolId
-
string
- nodeId
-
string
- userName
-
string
- options
- DeleteNodeUserOptionalParams
Gibt zurück
Promise<void>
deletePool(string, DeletePoolOptionalParams)
Wenn Sie anfordern, dass ein Pool gelöscht wird, treten die folgenden Aktionen auf: Der Poolstatus ist auf das Löschen festgelegt; alle laufenden Größenänderungsvorgänge im Pool werden beendet; Der Batchdienst startet die Größenänderung des Pools auf null Computeknoten; alle Aufgaben, die auf vorhandenen Computeknoten ausgeführt werden, werden beendet und erneut abgefragt (als ob ein Vorgang zur Größenänderung mit der Standardoption für die erneute Warteschlange angefordert wurde); schließlich wird der Pool aus dem System entfernt. Da die Ausführung von Aufgaben erneut abgefragt wird, kann der Benutzer diese Aufgaben erneut ausführen, indem er seinen Auftrag auf einen anderen Pool aktualisiert. Die Aufgaben können dann im neuen Pool ausgeführt werden. Wenn Sie das Verhalten der erneuten Warteschlange außer Kraft setzen möchten, sollten Sie die Größe des Pools explizit aufrufen, um die Größe des Pools auf null zu verkleinern, bevor Sie den Pool löschen. Wenn Sie eine Update-, Patch- oder Delete-API für einen Pool im Löschzustand aufrufen, schlägt sie mit dem HTTP-Statuscode 409 mit dem Fehlercode PoolBeingDeleted fehl.
function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>Parameter
- poolId
-
string
- options
- DeletePoolOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
deleteTask(string, string, DeleteTaskOptionalParams)
Wenn eine Aufgabe gelöscht wird, werden alle Dateien im Verzeichnis des Computeknotens, in dem sie ausgeführt wurde, ebenfalls gelöscht (unabhängig von der Aufbewahrungszeit). Bei Vorgängen mit mehreren Instanzen gilt der Vorgangslöschvorgang synchron für den primären Vorgang. Teilvorgänge und deren Dateien werden dann asynchron im Hintergrund gelöscht.
function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>Parameter
- jobId
-
string
- taskId
-
string
- options
- DeleteTaskOptionalParams
Gibt zurück
Promise<void>
deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)
Löscht die angegebene Vorgangsdatei aus dem Computeknoten, in dem die Aufgabe ausgeführt wurde.
function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>Parameter
- jobId
-
string
- taskId
-
string
- filePath
-
string
- options
- DeleteTaskFileOptionalParams
Gibt zurück
Promise<void>
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)
Der Batch-Service versetzt den Job sofort in den Zustand der Funktionsfähigkeit (Deaktivieren). Batch verwendet dann den Parameter disableTasks, um zu bestimmen, was mit den aktuell laufenden Aufgaben des Jobs geschehen soll. Der Job bleibt im Deaktivierungszustand, bis die Deaktivierungsoperation abgeschlossen ist und alle Aufgaben gemäß der DisableTasks-Option erledigt wurden; der Job wechselt dann in den behinderten Zustand. Unter dem Job werden keine neuen Aufgaben gestartet, bis er wieder in den aktiven Zustand zurückkehrt. Wenn du versuchst, einen Job zu deaktivieren, der sich in einem anderen Zustand als aktiv, deaktivierend oder deaktiviert befindet, schlägt die Anfrage mit Statuscode 409 fehl.
function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>Parameter
- jobId
-
string
- disableOptions
- BatchJobDisableOptions
- options
- DisableJobOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
disableJobSchedule(string, DisableJobScheduleOptionalParams)
Es werden keine neuen Aufträge erstellt, bis der Auftragsplan erneut aktiviert ist.
function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>Parameter
- jobScheduleId
-
string
- options
- DisableJobScheduleOptionalParams
Gibt zurück
Promise<void>
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)
Man kann die Aufgabenplanung auf einem Compute-Knoten nur deaktivieren, wenn dessen aktueller Planungszustand aktiviert ist.
function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>Parameter
- poolId
-
string
- nodeId
-
string
Gibt zurück
Promise<void>
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)
Deaktiviert die automatische Skalierung für einen Pool.
function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>Parameter
- poolId
-
string
Gibt zurück
Promise<void>
enableJob(string, EnableJobOptionalParams)
Wenn Sie diese API aufrufen, setzt der Batch-Service einen deaktivierten Job auf den aktivierten Zustand. Nach Abschluss dieser Operation wechselt der Job in den aktiven Zustand, und die Planung neuer Aufgaben unter dem Job wird fortgesetzt. Der Batch-Dienst erlaubt es nicht, dass eine Aufgabe länger als 180 Tage im aktiven Zustand bleibt. Wenn Sie also einen Job aktivieren, der aktive Aufgaben enthält, die vor mehr als 180 Tagen hinzugefügt wurden, werden diese Aufgaben nicht ausgeführt.
function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>Parameter
- jobId
-
string
- options
- EnableJobOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
enableJobSchedule(string, EnableJobScheduleOptionalParams)
Aktiviert einen Auftragsplan.
function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>Parameter
- jobScheduleId
-
string
- options
- EnableJobScheduleOptionalParams
Gibt zurück
Promise<void>
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)
Man kann die Task-Scheduling auf einem Compute-Node nur aktivieren, wenn dessen aktueller Planungszustand deaktiviert ist
function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>Parameter
- poolId
-
string
- nodeId
-
string
Gibt zurück
Promise<void>
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)
Sie können die automatische Skalierung für einen Pool nicht aktivieren, wenn ein Vorgang zum Ändern der Größe im Pool ausgeführt wird. Wenn die automatische Skalierung des Pools derzeit deaktiviert ist, müssen Sie eine gültige Autoskalenformel als Teil der Anforderung angeben. Wenn die automatische Skalierung des Pools bereits aktiviert ist, können Sie eine neue Autoskalenformel und/oder ein neues Auswertungsintervall angeben. Sie können diese API nicht für denselben Pool mehr als einmal alle 30 Sekunden aufrufen.
function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>Parameter
- poolId
-
string
- enableAutoScaleOptions
- BatchPoolEnableAutoScaleOptions
Gibt zurück
Promise<void>
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)
Diese API dient in erster Linie zum Validieren einer Autoskalenformel, da sie einfach das Ergebnis zurückgibt, ohne die Formel auf den Pool anzuwenden. Der Pool muss die automatische Skalierung aktiviert haben, um eine Formel auszuwerten.
function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>Parameter
- poolId
-
string
- evaluateAutoScaleOptions
- BatchPoolEvaluateAutoScaleOptions
Gibt zurück
Promise<AutoScaleRun>
getApplication(string, GetApplicationOptionalParams)
Diese Operation liefert nur Anwendungen und Versionen zurück, die für die Nutzung auf Compute Nodes verfügbar sind; das heißt, das kann in einer Paketreferenz verwendet werden. Für Administratorinformationen zu Anwendungen und Versionen, die den Compute Nodes noch nicht zur Verfügung stehen, verwenden Sie das Azure-Portal oder die Azure Resource Manager API.
function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>Parameter
- applicationId
-
string
- options
- GetApplicationOptionalParams
Gibt zurück
Promise<BatchApplication>
getJob(string, GetJobOptionalParams)
Erhält Informationen über den angegebenen Auftrag.
function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>Parameter
- jobId
-
string
- options
- GetJobOptionalParams
Gibt zurück
Promise<BatchJob>
getJobSchedule(string, GetJobScheduleOptionalParams)
Erhält Informationen über den angegebenen Arbeitsplan.
function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>Parameter
- jobScheduleId
-
string
- options
- GetJobScheduleOptionalParams
Gibt zurück
Promise<BatchJobSchedule>
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)
Aufgabenanzahlen stellen eine Anzahl der Aufgaben nach aktivem, ausgeführtem oder abgeschlossenem Vorgangsstatus und einer Anzahl von Aufgaben bereit, die erfolgreich waren oder fehlgeschlagen sind. Aufgaben im Vorbereitungszustand werden als ausgeführt gezählt. Beachten Sie, dass die zurückgegebenen Zahlen möglicherweise nicht immer auf dem neuesten Stand sind. Wenn Sie genaue Vorgangsanzahlen benötigen, verwenden Sie eine Listenabfrage.
function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>Parameter
- jobId
-
string
- options
- GetJobTaskCountsOptionalParams
Gibt zurück
Promise<BatchTaskCountsResult>
getNode(string, string, GetNodeOptionalParams)
Ruft Informationen zum angegebenen Computeknoten ab.
function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>Parameter
- poolId
-
string
- nodeId
-
string
- options
- GetNodeOptionalParams
Gibt zurück
Promise<BatchNode>
getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)
Erhält Informationen über die angegebene Compute Node Extension.
function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>Parameter
- poolId
-
string
- nodeId
-
string
- extensionName
-
string
- options
- GetNodeExtensionOptionalParams
Gibt zurück
Promise<BatchNodeVMExtension>
getNodeFile(string, string, string, GetNodeFileOptionalParams)
Gibt den Inhalt der angegebenen Compute-Node-Datei zurück.
function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>Parameter
- poolId
-
string
- nodeId
-
string
- filePath
-
string
- options
- GetNodeFileOptionalParams
Gibt zurück
Promise<Uint8Array>
getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)
Ruft die Eigenschaften der angegebenen Computeknotendatei ab.
function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>Parameter
- poolId
-
string
- nodeId
-
string
- filePath
-
string
Gibt zurück
Promise<BatchNodeFile>
getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)
Bevor Sie sich mit den Remote-Login-Einstellungen aus der Ferne bei einem Compute-Node anmelden können, müssen Sie ein Benutzerkonto auf dem Compute-Node erstellen und Zugriffsportarten für SSH und RDP konfigurieren. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>Parameter
- poolId
-
string
- nodeId
-
string
Gibt zurück
Promise<BatchNodeRemoteLoginSettings>
getPool(string, GetPoolOptionalParams)
Ruft Informationen zum angegebenen Pool ab.
function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>Parameter
- poolId
-
string
- options
- GetPoolOptionalParams
Gibt zurück
Promise<BatchPool>
getTask(string, string, GetTaskOptionalParams)
Für Multi-Instanz-Aufgaben beziehen sich Informationen wie affinityId, executionInfo und nodeInfo auf die primäre Aufgabe. Verwenden Sie die Liste der Unteraufgaben-API, um Informationen über Unteraufgaben abzurufen.
function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>Parameter
- jobId
-
string
- taskId
-
string
- options
- GetTaskOptionalParams
Gibt zurück
Promise<BatchTask>
getTaskFile(string, string, string, GetTaskFileOptionalParams)
Gibt den Inhalt der angegebenen Task-Datei zurück.
function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>Parameter
- jobId
-
string
- taskId
-
string
- filePath
-
string
- options
- GetTaskFileOptionalParams
Gibt zurück
Promise<Uint8Array>
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)
Ruft die Eigenschaften der angegebenen Vorgangsdatei ab.
function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>Parameter
- jobId
-
string
- taskId
-
string
- filePath
-
string
Gibt zurück
Promise<BatchNodeFile>
jobScheduleExists(string, JobScheduleExistsOptionalParams)
Überprüft, ob der angegebene Arbeitsplan existiert.
function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>Parameter
- jobScheduleId
-
string
- options
- JobScheduleExistsOptionalParams
Gibt zurück
Promise<boolean>
listApplications(ListApplicationsOptionalParams)
Diese Operation liefert nur Anwendungen und Versionen zurück, die für die Nutzung auf Compute Nodes verfügbar sind; das heißt, das kann in einer Paketreferenz verwendet werden. Für Administratorinformationen zu Anwendungen und Versionen, die den Compute Nodes noch nicht zur Verfügung stehen, verwenden Sie das Azure-Portal oder die Azure Resource Manager API.
function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>Parameter
- options
- ListApplicationsOptionalParams
Gibt zurück
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)
Diese API gibt den Auftragsvorbereitungs- und Auftragsveröffentlichungsvorgangsstatus für alle Computeknoten zurück, die die Aufgabe "Auftragsvorbereitung" oder "Auftragsfreigabe" ausgeführt haben. Dazu gehören Computeknoten, die seitdem aus dem Pool entfernt wurden. Wenn diese API für einen Auftrag aufgerufen wird, der keine Auftragsvorbereitungs- oder Auftragsfreigabeaufgabe enthält, gibt der Batchdienst DEN HTTP-Statuscode 409 (Conflict) mit einem Fehlercode von JobPreparationTaskNotSpecified zurück.
function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>Parameter
- jobId
-
string
Gibt zurück
listJobs(ListJobsOptionalParams)
Listet alle Jobs im angegebenen Konto auf.
function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>Parameter
- options
- ListJobsOptionalParams
Gibt zurück
listJobSchedules(ListJobSchedulesOptionalParams)
Listet alle Jobpläne im angegebenen Konto auf.
function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>Parameter
- options
- ListJobSchedulesOptionalParams
Gibt zurück
listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)
Listet die Jobs auf, die unter dem angegebenen Jobplan erstellt wurden.
function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>Parameter
- jobScheduleId
-
string
Gibt zurück
listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)
listet die Compute Nodes-Erweiterungen im angegebenen Pool auf.
function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>Parameter
- poolId
-
string
- nodeId
-
string
- options
- ListNodeExtensionsOptionalParams
Gibt zurück
listNodeFiles(string, string, ListNodeFilesOptionalParams)
Listet alle Dateien in Aufgabenverzeichnissen auf dem angegebenen Computeknoten auf.
function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>Parameter
- poolId
-
string
- nodeId
-
string
- options
- ListNodeFilesOptionalParams
Gibt zurück
listNodes(string, ListNodesOptionalParams)
Listet die Computeknoten im angegebenen Pool auf.
function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>Parameter
- poolId
-
string
- options
- ListNodesOptionalParams
Gibt zurück
listPoolNodeCounts(ListPoolNodeCountsOptionalParams)
Ruft die Anzahl der Computeknoten in jedem Zustand ab, gruppiert nach Pool. Beachten Sie, dass die zurückgegebenen Zahlen möglicherweise nicht immer auf dem neuesten Stand sind. Wenn Sie genaue Knotenanzahl benötigen, verwenden Sie eine Listenabfrage.
function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>Parameter
- options
- ListPoolNodeCountsOptionalParams
Gibt zurück
listPools(ListPoolsOptionalParams)
Listet alle Pools im angegebenen Konto auf.
function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>Parameter
- options
- ListPoolsOptionalParams
Gibt zurück
listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)
Wenn Sie keine $filter Klausel einschließlich einer poolId angeben, enthält die Antwort alle Pools, die im Konto im Zeitraum der zurückgegebenen Aggregationsintervalle vorhanden sind. Wenn Sie keine $filter Klausel angeben, die eine startTime- oder EndTime-Klausel enthält, werden diese Filter standardmäßig auf die Start- und Endzeiten des letzten verfügbaren Aggregationsintervalls festgelegt. d. h., nur das letzte Aggregationsintervall wird zurückgegeben.
function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>Parameter
Gibt zurück
listSubTasks(string, string, ListSubTasksOptionalParams)
Wenn die Aufgabe kein Vorgang mit mehreren Instanzen ist, gibt dies eine leere Auflistung zurück.
function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>Parameter
- jobId
-
string
- taskId
-
string
- options
- ListSubTasksOptionalParams
Gibt zurück
listSupportedImages(ListSupportedImagesOptionalParams)
Listet alle vom Azure Batch-Dienst unterstützten images für virtuelle Computer auf.
function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>Parameter
Gibt zurück
listTaskFiles(string, string, ListTaskFilesOptionalParams)
Listet die Dateien im Verzeichnis einer Aufgabe auf dem Computeknoten auf.
function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>Parameter
- jobId
-
string
- taskId
-
string
- options
- ListTaskFilesOptionalParams
Gibt zurück
listTasks(string, ListTasksOptionalParams)
Für Multi-Instanz-Aufgaben beziehen sich Informationen wie affinityId, executionInfo und nodeInfo auf die primäre Aufgabe. Verwenden Sie die Liste der Unteraufgaben-API, um Informationen über Unteraufgaben abzurufen.
function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>Parameter
- jobId
-
string
- options
- ListTasksOptionalParams
Gibt zurück
poolExists(string, PoolExistsOptionalParams)
Erhält grundlegende Eigenschaften eines Pools.
function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>Parameter
- poolId
-
string
- options
- PoolExistsOptionalParams
Gibt zurück
Promise<boolean>
reactivateTask(string, string, ReactivateTaskOptionalParams)
Durch die Reaktivierung kann ein Vorgang bis zur maximalen Wiederholungsanzahl erneut wiederholt werden. Der Status des Vorgangs wird in "aktiv" geändert. Da sich der Vorgang nicht mehr im Status "Abgeschlossen" befindet, sind alle vorherigen Beendigungscode- oder Fehlerinformationen nach der Reaktivierung nicht mehr verfügbar. Jedes Mal, wenn eine Aufgabe reaktiviert wird, wird die Wiederholungsanzahl auf 0 zurückgesetzt. Die Reaktivierung schlägt für Vorgänge fehl, die nicht abgeschlossen wurden oder die zuvor erfolgreich abgeschlossen wurden (mit einem Exitcode von 0). Darüber hinaus tritt ein Fehler auf, wenn der Auftrag abgeschlossen ist (oder beendet oder gelöscht wird).
function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>Parameter
- jobId
-
string
- taskId
-
string
- options
- ReactivateTaskOptionalParams
Gibt zurück
Promise<void>
rebootNode(string, string, RebootNodeOptionalParams)
Sie können einen Computeknoten nur neu starten, wenn er sich in einem Leerlauf- oder Ausführungszustand befindet.
function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>Parameter
- poolId
-
string
- nodeId
-
string
- options
- RebootNodeOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
reimageNode(string, string, ReimageNodeOptionalParams)
Sie können das Betriebssystem nur dann auf einem Computeknoten neu installieren, wenn es sich in einem Leerlauf- oder Ausführungszustand befindet. Diese API kann nur auf Pools aufgerufen werden, die mit der Cloud-Service-Konfigurationseigenschaft erstellt wurden.
function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>Parameter
- poolId
-
string
- nodeId
-
string
- options
- ReimageNodeOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)
Dieser Vorgang kann nur ausgeführt werden, wenn der Zuordnungsstatus des Pools stabil ist. Wenn dieser Vorgang ausgeführt wird, ändert sich der Zuordnungsstatus von stetig in Größenänderung. Jede Anforderung kann bis zu 100 Knoten entfernen.
function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>Parameter
- poolId
-
string
- removeOptions
- BatchNodeRemoveOptions
- options
- RemoveNodesOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
replaceJob(string, BatchJob, ReplaceJobOptionalParams)
Dies ersetzt vollständig alle aktualisierbaren Eigenschaften des Jobs. Zum Beispiel, wenn der Job mit Einschränkungen verbunden ist und keine Einschränkungen mit dieser Anfrage angegeben sind, entfernt der Batch-Service die bestehenden Einschränkungen.
function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>Parameter
- jobId
-
string
- job
- BatchJob
- options
- ReplaceJobOptionalParams
Gibt zurück
Promise<void>
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)
Dies ersetzt vollständig alle aktualisierbaren Eigenschaften des Jobplans. Wenn zum Beispiel die Schedule-Eigenschaft mit dieser Anfrage nicht angegeben ist, entfernt der Batch-Service den bestehenden Schedule. Änderungen an einem Jobplan betreffen nur Jobs, die nach der Aktualisierung durch den Dienstplan erstellt werden; derzeit laufende Jobs sind unbeeinträchtigt.
function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>Parameter
- jobScheduleId
-
string
- jobSchedule
- BatchJobSchedule
- options
- ReplaceJobScheduleOptionalParams
Gibt zurück
Promise<void>
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)
Diese Operation ersetzt alle aktualisierten Eigenschaften des Kontos. Wenn zum Beispiel das Element expiryTime nicht angegeben ist, wird der aktuelle Wert durch den Standardwert ersetzt und nicht unverändert gelassen. Man kann ein Benutzerkonto auf einem Compute-Node nur aktualisieren, wenn er sich im Leerlauf oder im laufenden Zustand befindet.
function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>Parameter
- poolId
-
string
- nodeId
-
string
- userName
-
string
- updateOptions
- BatchNodeUserUpdateOptions
- options
- ReplaceNodeUserOptionalParams
Gibt zurück
Promise<void>
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)
Dies ersetzt vollständig alle aktualisierbaren Eigenschaften des Pools. Zum Beispiel, wenn der Pool eine StartTask zugeordnet hat und StartTask mit dieser Anfrage nicht angegeben ist, entfernt der Batch-Service den bestehenden StartTask.
function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>Parameter
- poolId
-
string
Gibt zurück
Promise<void>
replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)
Aktualisiert die Eigenschaften der angegebenen Task.
function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>Parameter
- jobId
-
string
- taskId
-
string
- task
- BatchTask
- options
- ReplaceTaskOptionalParams
Gibt zurück
Promise<void>
resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)
Sie können die Größe eines Pools nur ändern, wenn der Zuordnungszustand stabil ist. Wenn die Größe des Pools bereits geändert wird, schlägt die Anforderung mit dem Statuscode 409 fehl. Wenn Sie die Größe eines Pools ändern, ändert sich der Zuordnungsstatus des Pools von stetig zur Größenänderung. Sie können die Größe von Pools, die für die automatische Skalierung konfiguriert sind, nicht ändern. Wenn Sie versuchen, dies zu tun, gibt der Batchdienst einen Fehler 409 zurück. Wenn Sie die Größe eines Pools nach unten ändern, wählt der Batchdienst aus, welche Computeknoten entfernt werden sollen. Verwenden Sie zum Entfernen bestimmter Computeknoten stattdessen die Computeknoten-API des Pools.
function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>Parameter
- poolId
-
string
- resizeOptions
- BatchPoolResizeOptions
- options
- ResizePoolOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
startNode(string, string, StartNodeOptionalParams)
Man kann einen Compute-Node nur dann starten, wenn er bereits ausgeräumt wurde.
function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>Parameter
- poolId
-
string
- nodeId
-
string
- options
- StartNodeOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
stopPoolResize(string, StopPoolResizeOptionalParams)
Dies stellt den Pool nicht in seinen vorherigen Zustand vor der Größenänderung zurück: Es verhindert nur weitere Änderungen, und der Pool behält seinen aktuellen Zustand bei. Nach dem Stoppen stabilisiert sich der Pool auf der Anzahl der Rechenknoten, bei der er sich zum Zeitpunkt der Stoppoperation befand. Während des Stoppbetriebs ändert sich der Zuweisungszustand des Pools zunächst zu stoppend und dann zu stationär. Eine Resize-Operation muss keine explizite Resize-Pool-Anfrage sein; diese API kann auch verwendet werden, um die anfängliche Größe des Pools beim Erstellen zu stoppen.
function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>Parameter
- poolId
-
string
- options
- StopPoolResizeOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
terminateJob(string, TerminateJobOptionalParams)
Wenn eine Anfrage zum Beenden des Jobs eingeht, setzt der Batch-Service den Job auf den Terminationszustand. Der Batch-Service beendet dann alle laufenden Tasks, die mit dem Job verknüpft sind, und führt alle erforderlichen Job-Release-Aufgaben aus. Dann wechselt der Job in den abgeschlossenen Zustand. Wenn es Aufgaben im aktiven Zustand im Job gibt, bleiben sie im aktiven Zustand. Sobald ein Job beendet ist, können keine neuen Aufgaben hinzugefügt werden und verbleibende aktive Aufgaben werden nicht geplant.
function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>Parameter
- jobId
-
string
- options
- TerminateJobOptionalParams
Gibt zurück
PollerLike<OperationState<void>, void>
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)
Beendet einen Auftragsplan.
function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>Parameter
- jobScheduleId
-
string
Gibt zurück
PollerLike<OperationState<void>, void>
terminateTask(string, string, TerminateTaskOptionalParams)
Wenn die Aufgabe beendet wurde, wird sie in den Status "Abgeschlossen" verschoben. Bei Vorgängen mit mehreren Instanzen gilt der Vorgang zum Beenden des Vorgangs synchron für den primären Vorgang. Teilvorgänge werden dann asynchron im Hintergrund beendet.
function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>Parameter
- jobId
-
string
- taskId
-
string
- options
- TerminateTaskOptionalParams
Gibt zurück
Promise<void>
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)
Dies ersetzt nur die in der Anfrage angegebenen Job-Eigenschaften. Wenn zum Beispiel der Job Einschränkungen hat und eine Anfrage das Element der Einschränkungen nicht angibt, behält der Auftrag die bestehenden Einschränkungen.
function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>Parameter
- jobId
-
string
- options
- UpdateJobOptionalParams
Gibt zurück
Promise<void>
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)
Dies ersetzt nur die in der Anfrage angegebenen Job Schedule-Eigenschaften. Wenn zum Beispiel die Schedule-Eigenschaft mit dieser Anfrage nicht angegeben ist, behält der Batch-Service den bestehenden Schedule. Änderungen an einem Jobplan betreffen nur Jobs, die nach der Aktualisierung durch den Dienstplan erstellt werden; derzeit laufende Jobs sind unbeeinträchtigt.
function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>Parameter
- jobScheduleId
-
string
- jobSchedule
- BatchJobScheduleUpdateOptions
- options
- UpdateJobScheduleOptionalParams
Gibt zurück
Promise<void>
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)
Dies ersetzt nur die in der Anfrage angegebenen Pool-Eigenschaften. Wenn zum Beispiel der Pool eine StartTask zugeordnet hat und eine Anfrage kein StartTask-Element angibt, behält der Pool das bestehende StartTask.
function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>Parameter
- poolId
-
string
- options
- UpdatePoolOptionalParams
Gibt zurück
Promise<void>
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)
Dies dient dazu, Azure Batch-Service-Logdateien automatisiert von Compute Nodes zu sammeln, falls Sie einen Fehler haben und an den Azure-Support eskalieren möchten. Die Azure Batch Dienstprotokolldateien sollten für Azure-Support freigegeben werden, um Fehler beim Debuggen mit dem Batchdienst zu unterstützen.
function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>Parameter
- poolId
-
string
- nodeId
-
string
- uploadOptions
- UploadBatchServiceLogsOptions
- options
- UploadNodeLogsOptionalParams
Gibt zurück
Promise<UploadBatchServiceLogsResult>