Delen via

Batch-resources beheren met Azure CLI

  • Artikel

U kunt uw Azure Batch-accounts en -resources beheren met behulp van de Azure-opdrachtregelinterface (Azure CLI). Er zijn opdrachten voor het maken en bijwerken van Batch-resources, zoals pools, taken en taken. U kunt ook scripts maken voor veel van dezelfde taken die u uitvoert via Batch-API's, PowerShell-cmdlets en Azure Portal.

U kunt de Azure CLI uitvoeren in Azure Cloud Shell of de Azure CLI lokaal installeren. Versies zijn beschikbaar voor Windows-, Mac- en Linux-besturingssystemen (OS).

In dit artikel wordt uitgelegd hoe u de Azure CLI gebruikt met Batch-accounts en -resources.

De Azure CLI instellen

Kies hoe u de Azure CLI wilt instellen:

Zie Aan de slag met de Azure CLI voordat u doorgaat als u de Azure CLI nog niet hebt gebruikt.

Als u de Azure CLI eerder lokaal hebt geïnstalleerd, moet u de installatie bijwerken naar de nieuwste versie.

Verifiëren met de Azure CLI

Als u de Azure CLI wilt gebruiken met Batch, meldt u zich eerst aan bij uw Azure-account en meldt u zich vervolgens aan bij uw Batch-account.

Aanmelden bij Azure-account

Als u de Azure CLI wilt gebruiken, meldt u zich eerst aan bij uw Azure-account. Deze stap biedt u toegang tot Azure Resource Manager-opdrachten, waaronder Batch Management-serviceopdrachten . Vervolgens kunt u opdrachten uitvoeren om Batch-accounts, sleutels, toepassingspakketten en quota te beheren.

U kunt uw Azure-account op twee manieren verifiëren in de Azure CLI. Als u zelf opdrachten wilt uitvoeren, meldt u zich interactief aan bij de Azure CLI. De Azure CLI slaat uw referenties in de cache op en kan dezelfde referenties gebruiken om u na te melden bij uw Batch-account . Als u opdrachten wilt uitvoeren vanuit een script of een toepassing, meldt u zich aan bij de Azure CLI met een service-principal.

Als u zich interactief wilt aanmelden bij de Azure CLI, voert u het volgende uitaz login:

az login

Aanmelden bij Batch-account

Meld u vervolgens aan bij uw Batch-account in de Azure CLI met behulp van de opdracht az batch account login . Deze stap biedt u toegang tot Batch-serviceopdrachten. Vervolgens kunt u Batch-resources beheren, zoals pools, taken en taken.

U kunt uw Batch-account op twee manieren verifiëren in de Azure CLI. De standaardmethode is om te verifiëren met behulp van Microsoft Entra-id. We raden u aan deze methode in de meeste scenario's te gebruiken. Een andere optie is het gebruik van gedeelde sleutelverificatie.

Als u Azure CLI-scripts maakt om Batch-opdrachten te automatiseren, kunt u een van beide verificatiemethoden gebruiken. In sommige scenario's is verificatie met gedeelde sleutels mogelijk eenvoudiger dan het maken van een service-principal.

Verifiëren met Microsoft Entra ID

De standaardmethode voor verificatie met uw Batch-account is via Microsoft Entra-id. Wanneer u zich interactief of met een service-principal aanmeldt bij de Azure CLI , kunt u dezelfde referenties in de cache gebruiken om u met Microsoft Entra ID aan te melden bij uw Batch-account. Deze verificatiemethode biedt ook op rollen gebaseerd toegangsbeheer van Azure (Azure RBAC). Met Azure RBAC is gebruikerstoegang afhankelijk van hun toegewezen rol, niet van accountsleutels. U hoeft alleen de Azure-rollen te beheren, niet accountsleutels. Microsoft Entra ID verwerkt vervolgens toegang en verificatie.

Als u zich wilt aanmelden bij uw Batch-account met Microsoft Entra-id, voert u uit az batch login. Zorg ervoor dat u de vereiste parameters opneemt voor de naam van uw Batch-account (-n) en de naam van uw resourcegroep (-g).

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

Verifiëren met gedeelde sleutel

U kunt ook verificatie met gedeelde sleutels gebruiken om u aan te melden bij uw Batch-account. Deze methode gebruikt de toegangssleutels voor uw account om Azure CLI-opdrachten voor de Batch-service te verifiëren.

Als u zich wilt aanmelden bij uw Batch-account met verificatie met gedeelde sleutels, voert az batch login u de parameter --shared-key-authuit. Zorg ervoor dat u de vereiste parameters opneemt voor de naam van uw Batch-account (-n) en de naam van uw resourcegroep (-g).

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

Batch-opdrachten leren

De azure CLI-referentiedocumentatie bevat een overzicht van alle Azure CLI-opdrachten voor Batch.

Als u alle Batch-opdrachten in de Azure CLI wilt weergeven, voert u de opdracht uit az batch -h.

Er zijn meerdere voorbeelden van CLI-scripts voor algemene Batch-taken. In deze voorbeelden ziet u hoe u veel beschikbare opdrachten gebruikt voor Batch in de Azure CLI. U kunt leren hoe u Batch-accounts, -pools, -taken en -taken maakt en beheert.

Opdrachten voor Batch CLI-extensies gebruiken

U kunt de Batch CLI-extensie gebruiken om Batch-taken uit te voeren zonder code te schrijven. De extensie biedt opdrachten voor het gebruik van JSON-sjablonen voor het maken van pools, taken en taken met de Azure CLI. De extensie biedt ook opdrachten om verbinding te maken met een Azure Storage-account dat is gekoppeld aan uw Batch-account. Vervolgens kunt u taakinvoerbestanden uploaden en taakinvoerbestanden downloaden.

Resources maken met JSON

U kunt de meeste Batch-resources maken met behulp van alleen opdrachtregelparameters. Voor sommige functies moet u in plaats daarvan een JSON-configuratiebestand opgeven. Het JSON-bestand bevat de configuratiegegevens voor uw nieuwe resource. U moet bijvoorbeeld een JSON-bestand gebruiken om resourcebestanden voor een begintaak op te geven.

Als u bijvoorbeeld een JSON-bestand wilt gebruiken om een nieuwe Batch-poolresource te configureren:

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

Wanneer u een JSON-bestand opgeeft voor een nieuwe resource, gebruikt u geen andere parameters in uw opdracht. De service gebruikt alleen het JSON-bestand om de resource te configureren.

In de naslagdocumentatie voor de Rest API van Batch worden alle JSON-syntaxis vermeld die nodig is om een resource te maken.

Informatie over de juiste JSON-syntaxis voor het maken van een resource vindt u in de Engelstalige Azure Batch REST API Reference. Ga naar de sectie Voorbeelden op de referentiepagina van de resourcebewerking. Zoek vervolgens de subsectie met de titel Resourcetype> toevoegen<. Voeg bijvoorbeeld een basistaak toe. Gebruik de voorbeeld-JSON-code als sjablonen voor uw configuratiebestanden.

Zie Running jobs on Azure Batch with Azure CLI (Taken uitvoeren in Azure Batch met Azure CLI) voor een voorbeeld van een script waarin een JSON-bestand is opgegeven.

Query's uitvoeren op Batch-resources efficiënt

U kunt een query uitvoeren op uw Batch-account en alle resources weergeven met behulp van de list opdracht. Als u bijvoorbeeld de pools in uw account en taken in een taak wilt weergeven:

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

Als u de hoeveelheid gegevens wilt beperken die uw Batch-query retourneert, geeft u een OData-component op. Alle filtering vindt plaats aan de serverzijde, zodat u alleen de gegevens ontvangt die u aanvraagt. Gebruik deze OData-componenten om bandbreedte en tijd te besparen met list bewerkingen. Zie Efficiënte lijstquery's ontwerpen voor Batch-resources voor meer informatie.

Component Omschrijving
--select-clause [select-clause] Retourneert een subset met eigenschappen voor elke entiteit.
--filter-clause [filter-clause] Retourneert alleen entiteiten die overeenkomen met de opgegeven OData-expressie.
--expand-clause [expand-clause] Vraagt de entiteitgegevens op in één onderliggende REST-aanroep. De component expand ondersteunt momenteel alleen de eigenschap stats.

Zie Een taak en taken uitvoeren met Batch voor een voorbeeldscript waarin wordt getoond hoe u deze componenten gebruikt.

Problemen oplossen

Als u hulp wilt krijgen bij een Batch-opdracht, voegt u deze toe -h aan het einde van de opdracht. Voeg geen andere opties toe. Voer bijvoorbeeld uit om hulp te krijgen bij het maken van een Batch-account az batch account create -h.

Als u uitgebreide opdrachtuitvoer wilt retourneren, voegt u de opdracht toe -v of -vv aan het einde van de opdracht. Gebruik deze schakelopties om de volledige foutuitvoer weer te geven. De -vv vlag retourneert de werkelijke REST-aanvragen en -antwoorden.

Als u de uitvoer van de opdracht in JSON-indeling wilt weergeven, voegt u deze toe --json aan het einde van de opdracht. Als u bijvoorbeeld de eigenschappen van een pool met de naam pool001 wilt weergeven, voert u de opdracht uit az batch pool show pool001 --json. Kopieer en wijzig vervolgens de uitvoer om Batch-resources te maken met behulp van een JSON-configuratiebestand.

Algemene problemen met Azure CLI oplossen

De Azure CLI kan in verschillende shell-omgevingen worden uitgevoerd, maar met kleine variaties in de indeling. Als u onverwachte resultaten hebt met Azure CLI-opdrachten, raadpleegt u De Azure CLI gebruiken.

Volgende stappen

Quickstart: Uw eerste Batch-taak uitvoeren met de Azure CLI