Verwalten von Batch-Ressourcen mit der Azure CLI
Sie können Ihre Azure Batch-Konten und -Ressourcen über die Azure-Befehlszeilenschnittstelle (Azure-Befehlszeilenschnittstelle) verwalten. Es gibt Befehle zum Erstellen und Aktualisieren von Batch-Ressourcen wie Pools, Jobs und Tasks. Sie können auch Skripts für viele der gleichen Aufgaben erstellen, die Sie über Batch-APIs, PowerShell-Cmdlets und das Azure-Portal ausführen.
Sie können die Azure-Befehlszeilenschnittstelle in Azure Cloud Shell ausführen oder die Azure-Befehlszeilenschnittstelle lokal installieren. Es gibt Versionen für Windows-, Mac- und Linux-Betriebssysteme (OS).
In diesem Artikel wird erklärt, wie man die Azure-Befehlszeilenschnittstelle mit Batch-Konten und -Ressourcen verwendet.
Einrichten der Azure CLI
Wählen Sie, wie Sie die Azure-Befehlszeilenschnittstelle einrichten möchten:
- Ausführen der Azure-Befehlszeilenschnittstelle in Cloud Shell.
- Installieren Sie das Azure-Befehlszeilenschnittstelle lokal.
Wenn Sie die Azure-Befehlszeilenschnittstelle zum ersten Mal verwenden, lesen Sie Einführung in die Azure-Befehlszeilenschnittstelle, bevor Sie fortfahren.
Wenn Sie Azure-Befehlszeilenschnittstelle bereits lokal installiert haben, stellen Sie sicher, dass Sie Ihre Installation auf die neueste Version aktualisieren.
Authentifizierung mit der Azure-Befehlszeilenschnittstelle
Um die Azure-Befehlszeilenschnittstelle mit Batch zu verwenden, melden Sie sich zunächst bei Ihrem Azure-Konto und dann bei Ihrem Batch-Konto an.
Bei Azure-Konto anmelden
Um die Azure-Befehlszeilenschnittstelle zu verwenden, melden Sie sich zunächst bei Ihrem Azure-Konto an. Mit diesem Schritt erhalten Sie Zugriff auf Azure Resource Manager-Befehle, zu denen auch Batch Management Service-Befehle gehören. Anschließend können Sie Befehle zur Verwaltung von Batch-Konten, Schlüsseln, Anwendungspaketen und Kontingenten ausführen.
Sie können Ihr Azure-Konto auf zwei Arten in der Azure-Befehlszeilenschnittstelle) authentifizieren. Um Befehle selbst auszuführen, melden Sie sich interaktiv bei der Azure-Befehlszeilenschnittstelle an. Die Azure-Befehlszeilenschnittstelle speichert Ihre Anmeldedaten und kann dieselben Anmeldedaten verwenden, um Sie später bei Ihrem Batch-Konto anzumelden. Um Befehle aus einem Skript oder einer Anwendung auszuführen, melden Sie sich mit einem Dienstprinzipal bei der Azure-Befehlszeilenschnittstelle an.
Um sich interaktiv bei der Azure-Befehlszeilenschnittstelle anzumelden, führen Sie az login aus:
az login
Anmeldung beim Batch-Konto
Melden Sie sich anschließend mit dem Befehl az batch account login bei Ihrem Batch-Konto in der Azure-Befehlszeilenschnittstelle an. In diesem Schritt erhalten Sie Zugriff auf die Befehle des Batch-Dienstes. Anschließend können Sie Batch-Ressourcen wie Pools, Aufträge und Aufgaben verwalten.
Sie können Ihr Batch-Konto in der Azure-Befehlszeilenschnittstelle auf zwei Arten authentifizieren. Die Standardmethode ist die Authentifizierung mit Microsoft Entra ID. Wir empfehlen, diese Methode in den meisten Fällen anzuwenden. Eine andere Möglichkeit ist die Verwendung der Shared Key-Authentifizierung.
Wenn Sie Azure-Befehlszeilenschnittstelle Skripte zur Automatisierung von Batch-Befehlen erstellen, können Sie beide Authentifizierungsmethoden verwenden. In einigen Szenarien kann die Authentifizierung mit einem gemeinsamen Schlüssel einfacher sein als die Erstellung eines Dienstprinzipals.
Authentifizierung mit Microsoft Entra ID
Die Standardmethode für die Authentifizierung mit Ihrem Batch-Konto ist über Microsoft Entra ID. Wenn Sie sich interaktiv oder mit einem Dienstprinzipal bei der Azure-Befehlszeilenschnittstelle anmelden, können Sie dieselben zwischengespeicherten Anmeldedaten verwenden, um sich bei Ihrem Batch-Konto mit Microsoft Entra ID anzumelden. Diese Authentifizierungsmethode bietet auch Azure rollenbasierte Zugriffskontrolle (Azure RBAC). Bei Azure RBAC hängt der Benutzerzugriff von der ihm zugewiesenen Rolle ab, nicht von den Kontoschlüsseln. Sie müssen nur die Azure-Rollen verwalten, nicht die Kontoschlüssel. Microsoft Entra ID verwaltet dann den Zugriff und die Authentifizierung.
Um sich bei Ihrem Batch-Konto mit Microsoft Entra ID anzumelden, führen Sie az batch login aus. Stellen Sie sicher, dass Sie die erforderlichen Parameter für den Namen Ihres Batch-Kontos (-n) und den Namen Ihrer Ressourcengruppe (-g) angeben.
az batch account login -g <your-resource-group> -n <your-batch-account>
Authentifizierung mit gemeinsamem Schlüssel
Sie können auch die Shared Key-Authentifizierung verwenden, um sich bei Ihrem Batch-Konto anzumelden. Bei dieser Methode werden Ihre Kontozugriffsschlüssel zur Authentifizierung von Azure-Befehlszeilenschnittstelle Befehlen für den Batch-Dienst verwendet.
Um sich bei Ihrem Batch-Konto mit Shared Key Authentifizierung anzumelden, führen Sie az batch login mit dem Parameter --shared-key-auth aus. Stellen Sie sicher, dass Sie die erforderlichen Parameter für den Namen Ihres Batch-Kontos (-n) und den Namen Ihrer Ressourcengruppe (-g) angeben.
az batch account login -g <your-resource-group> -n <your-batch-account> --shared-key-auth
Batch-Befehle lernen
In der Azure CLI-Referenzdokumentation sind alle Azure CLI-Befehle für Batch aufgeführt.
Um alle Batch-Befehle in der Azure-Befehlszeilenschnittstelle aufzulisten, führen Sie az batch -h aus.
Es gibt mehrere Beispiel-CLI-Skripte für allgemeine Batch-Aufgaben. Diese Beispiele zeigen, wie viele der verfügbaren Befehle für Batch in der Azure-Befehlszeilenschnittstelle verwendet werden können. Sie erfahren, wie Sie Batch-Konten, Pools, Aufträge und Aufgaben erstellen und verwalten können.
Batch CLI-Erweiterungsbefehle verwenden
Sie können die Batch CLI-Erweiterung verwenden, um Batch-Aufträge auszuführen, ohne Code zu schreiben. Die Erweiterung bietet Befehle zur Verwendung von JSON-Vorlagen für die Erstellung von Pools, Jobs und Tasks mit der Azure CLI. Die Erweiterung bietet auch Befehle für die Verbindung mit einem Azure Storage-Konto, das mit Ihrem Batch-Konto verknüpft ist. Dann können Sie Job-Eingabedateien hochladen und Job-Eingabedateien herunterladen.
Ressourcen mit JSON erstellen
Sie können die meisten Batch-Ressourcen nur mit Befehlszeilenparametern erstellen. Für einige Funktionen müssen Sie stattdessen eine JSON-Konfigurationsdatei angeben. Die JSON-Datei enthält die Konfigurationsdetails für Ihre neue Ressource. Sie müssen zum Beispiel eine JSON-Datei verwenden, um Ressourcendateien für eine Startaufgabe anzugeben.
Zum Beispiel, um eine JSON-Datei zu verwenden, um eine neue Batch-Pool-Ressource zu konfigurieren:
az batch pool <your-batch-pool-configuration>.json
Wenn Sie eine JSON-Datei für eine neue Ressource angeben, dürfen Sie keine anderen Parameter in Ihrem Befehl verwenden. Der Dienst verwendet die JSON-Datei nur zur Konfiguration der Ressource.
Das Dokument Batch REST API reference listet die JSON-Syntax auf, die zur Erstellung einer Ressource erforderlich ist.
Die für die Ressourcenerstellung erforderliche JSON-Syntax finden Sie in der Batch-REST-API-Referenz. Gehen Sie zum Abschnitt Beispiele auf der Referenzseite der Ressourcenoperation. Suchen Sie dann den Unterabschnitt mit der Überschrift Hinzufügen <Ressourcentyp>. Zum Beispiel: Hinzufügen einer Grundaufgabe. Verwenden Sie den JSON-Beispielcode als Vorlage für Ihre Konfigurationsdateien.
Ein Beispielskript, das eine JSON-Datei angibt, finden Sie unter Ausführen eines Auftrags und von Tasks mit Batch.
Effiziente Abfrage von Batch-Ressourcen
Sie können Ihr Batch-Konto abfragen und alle Ressourcen mit dem Befehl list auflisten. Zum Beispiel, um die Pools in Ihrem Konto und die Aufgaben in einem Auftrag aufzulisten:
az batch pool list
az batch task list --job-id <your-job-id>
Um die Menge der von Ihrer Batch-Abfrage zurückgegebenen Daten zu begrenzen, geben Sie eine OData-Klausel an. Die Filterung erfolgt serverseitig, so dass Sie nur die von Ihnen angeforderten Daten erhalten. Verwenden Sie diese OData-Klauseln, um bei list-Vorgängen Bandbreite und Zeit zu sparen. Weitere Informationen finden Sie unter Entwerfen Sie effiziente Listenabfragen für Batch-Ressourcen.
| Klausel | BESCHREIBUNG |
|---|---|
--select-clause [select-clause] |
Gibt für jede Entität eine Teilmenge der Eigenschaften zurück. |
--filter-clause [filter-clause] |
Gibt nur Entitäten zurück, die dem angegebenen OData-Ausdruck entsprechen. |
--expand-clause [expand-clause] |
Ruft die Entitätsinformationen in einem einzelnen zugrunde liegenden REST-Aufruf ab. Die expand-Klausel unterstützt nur die stats-Eigenschaft. |
Ein Beispielskript, das die Verwendung dieser Klauseln zeigt, finden Sie unter Auftrag und Aufgaben mit Batch ausführen.
Problembehandlung
Um Hilfe zu einem beliebigen Batch-Befehl zu erhalten, fügen Sie -h am Ende des Befehls hinzu. Fügen Sie keine weiteren Optionen hinzu. Um beispielsweise Hilfe bei der Erstellung eines Batch-Kontos zu erhalten, führen Sie az batch account create -h aus.
Um eine ausführliche Befehlsausgabe zu erhalten, fügen Sie -v oder -vv an das Ende Ihres Befehls an. Verwenden Sie diese Schalter, um die gesamte Fehlerausgabe anzuzeigen. Das Flag -vv gibt die tatsächlichen REST-Anforderung und -Antworten zurück.
Um die Befehlsausgabe im JSON-Format anzuzeigen, fügen Sie --json an das Ende Ihres Befehls an. Um zum Beispiel die Eigenschaften eines Pools mit dem Namen pool001 anzuzeigen, führen Sie az batch pool show pool001 --json aus. Kopieren und ändern Sie dann die Ausgabe, um Batch-Ressourcen mit einer JSON-Konfigurationsdatei zu erstellen.
Allgemeine Azure CLI-Problembehandlung
Die Azure CLI kann in mehreren Shellumgebungen ausgeführt werden, jedoch mit geringfügigen Formatvariationen. Wenn Sie unerwartete Ergebnisse mit Azure CLI-Befehlen haben, lesen Sie, wie Sie die Azure CLI erfolgreich verwenden.