Zarządzanie zasobami usługi Batch przy użyciu interfejsu wiersza polecenia platformy Azure

Konta i zasoby usługi Azure Batch można zarządzać przy użyciu interfejsu wiersza polecenia platformy Azure (interfejs wiersza polecenia platformy Azure). Istnieją polecenia służące do tworzenia i aktualizowania zasobów usługi Batch, takich jak pule, zadania i zadania podrzędne. Można również tworzyć skrypty dla wielu tych samych zadań wykonywanych za pomocą interfejsów API usługi Batch, poleceń cmdlet programu PowerShell i witryny Azure Portal.

Interfejs wiersza polecenia platformy Azure można uruchomić w usłudze Azure Cloud Shell lub zainstalować interfejs wiersza polecenia platformy Azure lokalnie. Wersje są dostępne dla systemów operacyjnych Windows, Mac i Linux.

W tym artykule wyjaśniono, jak używać interfejsu wiersza polecenia platformy Azure z kontami i zasobami usługi Batch.

Konfigurowanie interfejsu wiersza polecenia platformy Azure

Wybierz sposób konfigurowania interfejsu wiersza polecenia platformy Azure:

Jeśli dopiero zaczynasz korzystać z interfejsu wiersza polecenia platformy Azure, zobacz Wprowadzenie do interfejsu wiersza polecenia platformy Azure przed kontynuowaniem.

Jeśli wcześniej zainstalowano interfejs wiersza polecenia platformy Azure lokalnie, pamiętaj, aby zaktualizować instalację do najnowszej wersji.

Uwierzytelnianie za pomocą interfejsu wiersza polecenia platformy Azure

Aby użyć interfejsu wiersza polecenia platformy Azure z usługą Batch, najpierw zaloguj się do konta platformy Azure, a następnie zaloguj się do konta usługi Batch.

Zaloguj się do konta platformy Azure

Aby użyć interfejsu wiersza polecenia platformy Azure, najpierw zaloguj się do konta platformy Azure. Ten krok zapewnia dostęp do poleceń usługi Azure Resource Manager, które obejmują polecenia usługi Batch Management. Następnie można uruchamiać polecenia, aby zarządzać kontami, kluczami, pakietami aplikacji i limitami przydziału usługi Batch.

Konto platformy Azure można uwierzytelnić na dwa sposoby. Aby samodzielnie uruchomić polecenia, zaloguj się interaktywnie do interfejsu wiersza polecenia platformy Azure. Interfejs wiersza polecenia platformy Azure buforuje poświadczenia i może użyć tych samych poświadczeń, aby zalogować się do konta usługi Batch po. Aby uruchomić polecenia ze skryptu lub aplikacji, zaloguj się do interfejsu wiersza polecenia platformy Azure przy użyciu jednostki usługi.

Aby interaktywnie zalogować się do interfejsu wiersza polecenia platformy Azure, uruchom polecenie az login:

az login

Zaloguj się do konta usługi Batch

Następnie zaloguj się do konta usługi Batch w interfejsie wiersza polecenia platformy Azure przy użyciu polecenia az batch account login . Ten krok zapewnia dostęp do poleceń usługi Batch. Następnie można zarządzać zasobami usługi Batch, takimi jak pule, zadania i zadania.

Konto usługi Batch można uwierzytelnić na dwa sposoby w interfejsie wiersza polecenia platformy Azure. Domyślną metodą jest uwierzytelnianie przy użyciu identyfikatora Entra firmy Microsoft. W większości scenariuszy zalecamy użycie tej metody. Inną opcją jest użycie uwierzytelniania za pomocą klucza współużytkowanego.

Jeśli tworzysz skrypty interfejsu wiersza polecenia platformy Azure w celu zautomatyzowania poleceń usługi Batch, możesz użyć jednej z metod uwierzytelniania. W niektórych scenariuszach uwierzytelnianie klucza współdzielonego może być prostsze niż utworzenie jednostki usługi.

Uwierzytelnianie przy użyciu usługi Microsoft Entra ID

Domyślną metodą uwierzytelniania przy użyciu konta usługi Batch jest identyfikator Entra firmy Microsoft. Po interakcyjnym logowaniu się do interfejsu wiersza polecenia platformy Azure lub przy użyciu jednostki usługi możesz użyć tych samych poświadczeń w pamięci podręcznej, aby zalogować się do konta usługi Batch przy użyciu identyfikatora Microsoft Entra. Ta metoda uwierzytelniania oferuje również kontrolę dostępu opartą na rolach platformy Azure (Azure RBAC). W przypadku kontroli dostępu opartej na rolach platformy Azure dostęp użytkowników zależy od przypisanej roli, a nie kluczy kont. Wystarczy zarządzać rolami platformy Azure, a nie kluczami konta. Identyfikator Entra firmy Microsoft obsługuje następnie dostęp i uwierzytelnianie.

Aby zalogować się do konta usługi Batch przy użyciu identyfikatora Microsoft Entra ID, uruchom polecenie az batch login. Pamiętaj, aby uwzględnić parametry wymagane dla nazwy konta usługi Batch (-n) i nazwy grupy zasobów (-g).

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

Uwierzytelnianie przy użyciu klucza współużytkowanego

Możesz również użyć uwierzytelniania klucza współdzielonego, aby zalogować się do konta usługi Batch. Ta metoda używa kluczy dostępu do konta do uwierzytelniania poleceń interfejsu wiersza polecenia platformy Azure dla usługi Batch.

Aby zalogować się do konta usługi Batch przy użyciu uwierzytelniania za pomocą klucza współużytkowanego, uruchom polecenie az batch login z parametrem --shared-key-auth. Pamiętaj, aby uwzględnić parametry wymagane dla nazwy konta usługi Batch (-n) i nazwy grupy zasobów (-g).

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

Polecenia usługi Batch w usłudze Learn

Dokumentacja referencyjna interfejsu wiersza polecenia platformy Azure zawiera listę wszystkich poleceń interfejsu wiersza polecenia platformy Azure dla usługi Batch.

Aby wyświetlić listę wszystkich poleceń usługi Batch w interfejsie wiersza polecenia platformy Azure, uruchom polecenie az batch -h.

Istnieje wiele przykładowych skryptów interfejsu wiersza polecenia dla typowych zadań usługi Batch. W tych przykładach pokazano, jak używać wielu dostępnych poleceń dla usługi Batch w interfejsie wiersza polecenia platformy Azure. Dowiesz się, jak tworzyć konta, pule, zadania i zadania usługi Batch oraz zarządzać nimi.

Używanie poleceń rozszerzenia interfejsu wiersza polecenia usługi Batch

Za pomocą rozszerzenia interfejsu wiersza polecenia usługi Batch można uruchamiać zadania usługi Batch bez pisania kodu. Rozszerzenie udostępnia polecenia umożliwiające używanie szablonów JSON do tworzenia pul, zadań i zadań za pomocą interfejsu wiersza polecenia platformy Azure. Rozszerzenie udostępnia również polecenia umożliwiające nawiązanie połączenia z kontem usługi Azure Storage połączonym z kontem usługi Batch. Następnie możesz przekazać pliki wejściowe zadania i pobrać pliki wejściowe zadania.

Tworzenie zasobów przy użyciu formatu JSON

Większość zasobów usługi Batch można utworzyć przy użyciu tylko parametrów wiersza polecenia. Niektóre funkcje wymagają określenia pliku konfiguracji JSON. Plik JSON zawiera szczegóły konfiguracji nowego zasobu. Na przykład musisz użyć pliku JSON, aby określić pliki zasobów dla zadania uruchamiania.

Aby na przykład użyć pliku JSON do skonfigurowania nowego zasobu puli usługi Batch:

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

Po określeniu pliku JSON dla nowego zasobu nie używaj innych parametrów w poleceniu. Usługa używa tylko pliku JSON do skonfigurowania zasobu.

Dokumentacja referencyjna interfejsu API REST usługi Batch zawiera listę dowolnej składni JSON wymaganej do utworzenia zasobu.

Aby zapoznać się ze składnią pliku JSON wymaganego do utworzenia zasobu, skorzystaj z dokumentacji interfejsu API REST usługi Batch. Przejdź do sekcji Przykłady na stronie referencyjnej operacji zasobów. Następnie znajdź podsekcję o nazwie Dodaj <typ> zasobu. Na przykład Dodaj zadanie podstawowe. Użyj przykładowego kodu JSON jako szablonów dla plików konfiguracji.

Aby uzyskać przykładowy skrypt określający plik JSON, zobacz Uruchamianie zadań i zadań podrzędnych za pomocą usługi Batch.

Wydajne wykonywanie zapytań o zasoby usługi Batch

Możesz wykonać zapytanie dotyczące konta usługi Batch i wyświetlić listę wszystkich zasobów przy użyciu list polecenia . Aby na przykład wyświetlić listę pul na koncie i zadaniach w zadaniu:

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

Aby ograniczyć ilość danych zwracanych przez zapytanie usługi Batch, określ klauzulę OData. Wszystkie filtrowanie odbywa się po stronie serwera, więc otrzymujesz tylko żądane dane. Użyj tych klauzul OData, aby zaoszczędzić przepustowość i czas przy list użyciu operacji. Aby uzyskać więcej informacji, zobacz Projektowanie wydajnych zapytań list dla zasobów usługi Batch.

Klauzula opis
--select-clause [select-clause] Zwracanie podzbioru właściwości dla każdej jednostki.
--filter-clause [filter-clause] Zwracanie tylko jednostek, które pasują do określonego wyrażenia OData.
--expand-clause [expand-clause] Uzyskiwanie informacji dotyczących jednostki w pojedynczym, podstawowym wywołaniu REST. Klauzula expand obsługuje obecnie tylko właściwość stats.

Przykładowy skrypt pokazujący sposób używania tych klauzul można znaleźć w temacie Run a job and tasks with Batch (Uruchamianie zadania i zadań w usłudze Batch).

Rozwiązywanie problemów

Aby uzyskać pomoc dotyczącą dowolnego polecenia usługi Batch, dodaj -h go na końcu polecenia. Nie dodawaj innych opcji. Aby na przykład uzyskać pomoc dotyczącą tworzenia konta usługi Batch, uruchom polecenie az batch account create -h.

Aby zwrócić pełne dane wyjściowe polecenia, dodaj -v polecenie lub -vv na końcu polecenia. Użyj tych przełączników, aby wyświetlić pełne dane wyjściowe błędu. Flaga -vv zwraca rzeczywiste żądania REST i odpowiedzi.

Aby wyświetlić dane wyjściowe polecenia w formacie JSON, dodaj --json na końcu polecenia. Aby na przykład wyświetlić właściwości puli o nazwie pool001, uruchom polecenie az batch pool show pool001 --json. Następnie skopiuj i zmodyfikuj dane wyjściowe, aby utworzyć zasoby usługi Batch przy użyciu pliku konfiguracji JSON.

Ogólne rozwiązywanie problemów z interfejsem wiersza polecenia platformy Azure

Interfejs wiersza polecenia platformy Azure może działać w kilku środowiskach powłoki, ale z niewielkimi odmianami formatu. Jeśli masz nieoczekiwane wyniki za pomocą poleceń interfejsu wiersza polecenia platformy Azure, zobacz Jak pomyślnie używać interfejsu wiersza polecenia platformy Azure.

Następne kroki