Hantera Batch-resurser med Azure CLI

  • Artikel

Du kan hantera dina Azure Batch-konton och -resurser med hjälp av Azure Command-Line Interface (Azure CLI). Det finns kommandon för att skapa och uppdatera Batch-resurser, till exempel pooler, jobb och uppgifter. Du kan också skapa skript för många av de uppgifter som du utför via Batch-API:er, PowerShell-cmdletar och Azure-portalen.

Du kan köra Azure CLI i Azure Cloud Shell eller installera Azure CLI lokalt. Versioner är tillgängliga för Windows-, Mac- och Linux-operativsystem (OS).

Den här artikeln beskriver hur du använder Azure CLI med Batch-konton och resurser.

Konfigurera Azure CLI

Välj hur du vill konfigurera Azure CLI:

Om du inte har använt Azure CLI tidigare kan du läsa Kom igång med Azure CLI innan du fortsätter.

Om du tidigare har installerat Azure CLI lokalt måste du uppdatera installationen till den senaste versionen.

Autentisera med Azure CLI

Om du vill använda Azure CLI med Batch loggar du först in på ditt Azure-konto och loggar sedan in på ditt Batch-konto.

Logga in på Azure-konto

Om du vill använda Azure CLI loggar du först in på ditt Azure-konto. Det här steget ger dig åtkomst till Azure Resource Manager-kommandon, som innehåller Batch Management-tjänstkommandon . Sedan kan du köra kommandon för att hantera Batch-konton, nycklar, programpaket och kvoter.

Du kan autentisera ditt Azure-konto i Azure CLI) på två sätt. Om du vill köra kommandon själv loggar du in på Azure CLI interaktivt. Azure CLI cachelagrar dina autentiseringsuppgifter och kan använda samma autentiseringsuppgifter för att logga in på ditt Batch-konto efter. Om du vill köra kommandon från ett skript eller ett program loggar du in på Azure CLI med tjänstens huvudnamn.

Om du vill logga in på Azure CLI interaktivt kör du az login:

az login

Logga in på Batch-konto

Logga sedan in på ditt Batch-konto i Azure CLI med kommandot az batch account login . Det här steget ger dig åtkomst till Batch-tjänstkommandon. Sedan kan du hantera Batch-resurser som pooler, jobb och uppgifter.

Du kan autentisera ditt Batch-konto i Azure CLI på två sätt. Standardmetoden är att autentisera med Hjälp av Microsoft Entra-ID. Vi rekommenderar att du använder den här metoden i de flesta scenarier. Ett annat alternativ är att använda autentisering med delad nyckel.

Om du skapar Azure CLI-skript för att automatisera Batch-kommandon kan du använda någon av autentiseringsmetoderna. I vissa scenarier kan autentisering med delad nyckel vara enklare än att skapa ett huvudnamn för tjänsten.

Autentisera med Microsoft Entra ID

Standardmetoden för att autentisera med ditt Batch-konto är via Microsoft Entra-ID. När du loggar in på Azure CLI interaktivt eller med ett huvudnamn för tjänsten kan du använda samma cachelagrade autentiseringsuppgifter för att logga in dig på ditt Batch-konto med Microsoft Entra-ID. Den här autentiseringsmetoden erbjuder även rollbaserad åtkomstkontroll i Azure (Azure RBAC). Med Azure RBAC är användaråtkomst beroende av deras tilldelade roll, inte kontonycklar. Du behöver bara hantera Azure-rollerna, inte kontonycklar. Microsoft Entra-ID hanterar sedan åtkomst och autentisering.

Om du vill logga in på ditt Batch-konto med Microsoft Entra-ID kör du az batch login. Se till att inkludera krävparametrarna för batchkontots namn (-n) och resursgruppens namn (-g).

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

Autentisera med delad nyckel

Du kan också använda autentisering med delad nyckel för att logga in på ditt Batch-konto. Den här metoden använder dina kontoåtkomstnycklar för att autentisera Azure CLI-kommandon för Batch-tjänsten.

Om du vill logga in på ditt Batch-konto med autentisering med delad nyckel kör du az batch login med parametern --shared-key-auth. Se till att inkludera krävparametrarna för batchkontots namn (-n) och resursgruppens namn (-g).

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

Learn Batch-kommandon

I Referensdokumentationen för Azure CLI visas alla Azure CLI-kommandon för Batch.

Om du vill visa en lista över alla Batch-kommandon i Azure CLI kör du az batch -h.

Det finns flera exempel på CLI-skript för vanliga Batch-uppgifter. De här exemplen visar hur du använder många tillgängliga kommandon för Batch i Azure CLI. Du kan lära dig hur du skapar och hanterar Batch-konton, pooler, jobb och uppgifter.

Använda Batch CLI-tilläggskommandon

Du kan använda Batch CLI-tillägget för att köra Batch-jobb utan att skriva kod. Tillägget innehåller kommandon för att använda JSON-mallar för att skapa pooler, jobb och uppgifter med Azure CLI. Tillägget innehåller även kommandon för att ansluta till ett Azure Storage-konto som är länkat till ditt Batch-konto. Sedan kan du ladda upp jobbindatafiler och ladda ned jobbindatafiler.

Skapa resurser med JSON

Du kan skapa de flesta Batch-resurser med endast kommandoradsparametrar. Vissa funktioner kräver att du anger en JSON-konfigurationsfil i stället. JSON-filen innehåller konfigurationsinformationen för den nya resursen. Du måste till exempel använda en JSON-fil för att ange resursfiler för en startaktivitet.

Om du till exempel vill använda en JSON-fil för att konfigurera en ny Batch-poolresurs:

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

När du anger en JSON-fil för en ny resurs ska du inte använda andra parametrar i kommandot. Tjänsten använder bara JSON-filen för att konfigurera resursen.

Referensdokumentationen för Batch REST API innehåller alla JSON-syntaxer som krävs för att skapa en resurs.

Du kan läsa vilken JSON-syntax som krävs för att skapa en resurs i dokumentationen Batch REST API reference (REST API-referens för Batch). Gå till avsnittet Exempel på resursåtgärdens referenssida. Leta sedan reda på underavsnittet Lägg till <resurstyp>. Lägg till exempel till en grundläggande uppgift. Använd JSON-exempelkoden som mallar för dina konfigurationsfiler.

Ett exempelskript som anger en JSON-fil finns i Köra ett jobb och aktiviteter med Batch.

Köra effektiva frågor mot Batch-resurser

Du kan fråga ditt Batch-konto och visa en lista över alla resurser med hjälp av list kommandot . Om du till exempel vill visa en lista över poolerna i ditt konto och aktiviteter i ett jobb:

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

Om du vill begränsa mängden data som batchfrågan returnerar anger du en OData-sats. All filtrering sker på serversidan, så du får bara de data du begär. Använd dessa OData-satser för att spara bandbredd och tid med list åtgärder. Mer information finns i Utforma effektiva listfrågor för Batch-resurser.

Sats Description
--select-clause [select-clause] Returnerar en delmängd av egenskaperna för varje entitet.
--filter-clause [filter-clause] Returnerar endast de enheter som matchar det angivna OData-uttrycket.
--expand-clause [expand-clause] Hämtar entitetsinformationen i ett enda underliggande REST-anrop. expand-satsen har för närvarande bara stöd för egenskapen stats.

Ett exempelskript som visar hur du använder dessa satser finns i Köra ett jobb och uppgifter med Batch.

Felsökning

Om du vill få hjälp med ett Batch-kommando lägger du till -h i slutet av kommandot. Lägg inte till andra alternativ. Om du till exempel vill få hjälp med att skapa ett Batch-konto kör du az batch account create -h.

Om du vill returnera utförliga kommandoutdata lägger du till -v eller -vv i slutet av kommandot. Använd dessa växlar för att visa fullständiga felutdata. Flaggan -vv returnerar faktiska REST-begäranden och svar.

Om du vill visa kommandoutdata i JSON-format lägger du till --json i slutet av kommandot. Om du till exempel vill visa egenskaperna för en pool med namnet pool001 kör du az batch pool show pool001 --json. Kopiera och ändra sedan utdata för att skapa Batch-resurser med hjälp av en JSON-konfigurationsfil.

Allmän Azure CLI-felsökning

Azure CLI kan köras i flera gränssnittsmiljöer, men med små formatvariationer. Om du har oväntade resultat med Azure CLI-kommandon kan du läsa Så här använder du Azure CLI.

Nästa steg

Snabbstart: Kör ditt första Batch-jobb med Azure CLI