Freigeben über

Verwalten von Batchressourcen mit Azure CLI

Sie können Ihre Azure Batch-Konten und -Ressourcen mithilfe der Azure Command-Line Interface (Azure CLI) verwalten. Es gibt Befehle zum Erstellen und Aktualisieren von Batchressourcen wie Pools, Aufträgen und Aufgaben. 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 CLI in Azure Cloud Shell ausführen oder die Azure CLI lokal installieren. Versionen sind für Windows-, Mac- und Linux-Betriebssysteme (OS) verfügbar.

In diesem Artikel wird erläutert, wie Sie die Azure CLI mit Batchkonten und Ressourcen verwenden.

Einrichten der Azure CLI

Wählen Sie aus, wie Sie die Azure CLI einrichten möchten:

Wenn Sie noch nicht mit der Azure CLI vertraut sind, lesen Sie "Erste Schritte mit der Azure CLI ", bevor Sie fortfahren.

Wenn Sie die Azure CLI zuvor lokal installiert haben, stellen Sie sicher, dass Sie Ihre Installation auf die neueste Version aktualisieren.

Authentifizieren mit der Azure CLI

Um die Azure CLI mit Batch zu verwenden, melden Sie sich zuerst bei Ihrem Azure-Konto an, und melden Sie sich dann bei Ihrem Batchkonto an.

Anmelden bei Azure-Konto

Um die Azure CLI zu verwenden, melden Sie sich zuerst bei Ihrem Azure-Konto an. Dieser Schritt bietet Ihnen Zugriff auf Azure Resource Manager-Befehle, die Batchverwaltungsdienstbefehle enthalten. Anschließend können Sie Befehle ausführen, um Batchkonten, Schlüssel, Anwendungspakete und Kontingente zu verwalten.

Sie können Ihr Azure-Konto in der Azure CLI auf zwei Arten authentifizieren. Um Befehle selbst auszuführen, melden Sie sich interaktiv bei der Azure CLI 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 CLI an.

Um sich interaktiv bei der Azure CLI anzumelden, führen Sie Folgendes aus az login:

az login

Anmelden beim Batchkonto

Melden Sie sich als Nächstes mit dem Anmeldebefehl "az batchkonto" bei Ihrem Batchkonto in der Azure CLI an. Mit diesem Schritt erhalten Sie Zugriff auf Batchdienstbefehle. Anschließend können Sie Batchressourcen wie Pools, Aufträge und Aufgaben verwalten.

Sie können Ihr Batchkonto in der Azure CLI auf zwei Arten authentifizieren. Die Standardmethode ist die Authentifizierung mithilfe der Microsoft Entra-ID. Wir empfehlen die Verwendung dieser Methode in den meisten Szenarien. Eine weitere Option besteht darin, die Authentifizierung mit freigegebenem Schlüssel zu verwenden.

Wenn Sie Azure CLI-Skripts zum Automatisieren von Batchbefehlen erstellen, können Sie eine der beiden Authentifizierungsmethoden verwenden. In einigen Szenarien ist die Authentifizierung mit gemeinsam genutzten Schlüsseln möglicherweise einfacher als das Erstellen eines Dienstprinzipals.

Authentifizierung mit Microsoft Entra ID

Die Standardmethode für die Authentifizierung mit Ihrem Batchkonto erfolgt über die Microsoft Entra-ID. Wenn Sie sich interaktiv oder mit einem Service Principal bei der Azure CLI anmelden, können Sie dieselben zwischengespeicherten Anmeldeinformationen verwenden, um sich mit Microsoft Entra ID bei Ihrem Batchkonto anzumelden. Diese Authentifizierungsmethode bietet auch die Azure rollenbasierte Zugriffssteuerung (Azure RBAC). Bei Azure RBAC hängt der Benutzerzugriff von ihrer zugewiesenen Rolle und nicht von Kontoschlüsseln ab. Sie müssen nur die Azure-Rollen und keine Kontoschlüssel verwalten. Microsoft Entra-ID verarbeitet dann Den Zugriff und die Authentifizierung.

Um sich mit der Microsoft Entra ID bei Ihrem Batch-Konto anzumelden, führen Sie az batch login aus. Stellen Sie sicher, dass Sie die erforderlichen Parameter für den Namen Ihres Batchkontos (-n) und den Namen (-g) Ihrer Ressourcengruppe einschließen.

az batch account login -g <your-resource-group> -n <your-batch-account>

Authentifizieren mit freigegebenem Schlüssel

Sie können auch die Authentifizierung mit gemeinsam genutztem Schlüssel verwenden, um sich bei Ihrem Batchkonto anzumelden. Diese Methode verwendet Ihre Kontozugriffsschlüssel, um Azure CLI-Befehle für den Batchdienst zu authentifizieren.

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 Batchkontos (-n) und den Namen (-g) Ihrer Ressourcengruppe einschließen.

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.

Führen Sie zum Auflisten aller Batchbefehle in der Azure CLI aus az batch -h.

Es gibt mehrere Beispiel-CLI-Skripts für allgemeine Batchaufgaben. In diesen Beispielen wird gezeigt, wie Sie viele verfügbare Befehle für Batch in der Azure CLI verwenden. Erfahren Sie, wie Sie Batchkonten, Pools, Aufträge und Aufgaben erstellen und verwalten.

Verwenden von Batch CLI-Erweiterungsbefehlen

Sie können die Batch CLI-Erweiterung verwenden , um Batchaufträge auszuführen, ohne Code zu schreiben. Die Erweiterung stellt Befehle bereit, um JSON-Vorlagen zum Erstellen von Pools, Aufträgen und Aufgaben mit der Azure CLI zu verwenden. Die Erweiterung bietet auch Befehle zum Herstellen einer Verbindung mit einem Azure Storage-Konto, das mit Ihrem Batchkonto verknüpft ist. Anschließend können Sie Auftragseingabedateien hochladen und Auftragseingabedateien herunterladen.

Erstellen von Ressourcen mit JSON

Sie können die meisten Batchressourcen nur mit Befehlszeilenparametern erstellen. Für einige Features müssen Sie stattdessen eine JSON-Konfigurationsdatei angeben. Die JSON-Datei enthält die Konfigurationsdetails für Ihre neue Ressource. Beispielsweise müssen Sie eine JSON-Datei verwenden, um Ressourcendateien für einen Startvorgang anzugeben.

So können Sie beispielsweise eine JSON-Datei verwenden, um eine neue Batchpoolressource zu konfigurieren:

az batch pool <your-batch-pool-configuration>.json

Wenn Sie eine JSON-Datei für eine neue Ressource angeben, verwenden Sie keine anderen Parameter in Ihrem Befehl. Der Dienst verwendet nur die JSON-Datei, um die Ressource zu konfigurieren.

In der Referenzdokumentation zur Batch-REST-API sind alle JSON-Syntax aufgeführt, die zum Erstellen einer Ressource erforderlich sind.

Informationen zur JSON-Syntax, die zum Erstellen einer Ressource erforderlich ist, finden Sie in der Referenzdokumentation zur Batch-REST-API . Wechseln Sie zum Abschnitt "Beispiele " auf der Referenzseite des Ressourcenvorgangs. Suchen Sie dann den Unterabschnitt "Ressourcentyp< hinzufügen">. Fügen Sie z. B. eine einfache Aufgabe hinzu. Verwenden Sie den BEISPIEL-JSON-Code als Vorlagen für Ihre Konfigurationsdateien.

Ein Beispielskript, das eine JSON-Datei angibt, finden Sie unter Ausführen eines Auftrags und aufgaben mit Batch.

Ressourcen im Batch effizient abfragen

Sie können Ihr Batchkonto abfragen und alle Ressourcen mithilfe des list Befehls auflisten. Um beispielsweise die Pools in Ihrem Konto und Aufgaben in einem Auftrag aufzulisten:

az batch pool list
az batch task list --job-id <your-job-id>

Geben Sie eine OData-Klausel an, um die Von der Batchabfrage zurückgegebene Datenmenge einzuschränken. Alle Filterung erfolgt serverseitig, sodass Sie nur die von Ihnen angeforderten Daten erhalten. Verwenden Sie diese OData-Klauseln, um Bandbreite und Zeit mit list Vorgängen zu sparen. Weitere Informationen finden Sie unter Entwerfen effizienter Listenabfragen für Batchressourcen.

Klausel Description
--select-clause [select-clause] Gibt eine Teilmenge von Eigenschaften für jede Entität 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 Erweiterungsklausel unterstützt derzeit nur die stats Eigenschaft.

Ein Beispielskript, das zeigt, wie diese Klauseln verwendet werden, finden Sie unter Ausführen eines Auftrags und aufgaben mit Batch.

Problembehandlung

Um Hilfe zu einem beliebigen Batchbefehl zu erhalten, fügen Sie -h am Ende des Befehls hinzu. Fügen Sie keine weiteren Optionen hinzu. Um beispielsweise Hilfe beim Erstellen eines Batchkontos zu erhalten, führen Sie den folgenden Befehl aus: az batch account create -h.

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 vollständige Fehlerausgabe anzuzeigen. Das -vv Flag gibt die tatsächlichen REST-Anforderungen und -Antworten zurück.

Um die Befehlsausgabe im JSON-Format anzuzeigen, fügen Sie --json am Ende des Befehls hinzu. Um beispielsweise die Eigenschaften eines Pools mit dem Namen "pool001" anzuzeigen, führen Sie aus az batch pool show pool001 --json. Kopieren und ändern Sie dann die Ausgabe, um Batchressourcen mithilfe einer JSON-Konfigurationsdatei zu erstellen.

Allgemeine Azure CLI-Problembehandlung

Die Azure CLI kann mit geringfügigen Formatvariationen in verschiedenen Shellumgebungen ausgeführt werden. Wenn Sie unerwartete Ergebnisse mit Azure CLI-Befehlen haben, lesen Sie, wie Sie die Azure CLI erfolgreich verwenden.

Nächste Schritte

Schnellstart: Ausführen Ihres ersten Batchauftrags mit der Azure CLI

  • Last updated on