Управление ресурсами "Batch" с помощью Azure CLI

Вы можете управлять учетными записями и ресурсами пакетной службы Azure с помощью интерфейса Azure Command-Line (Azure CLI). Существуют команды для создания и обновления Batch ресурсов, таких как пулы, задания и задачи. Вы также можете создавать скрипты для многих из этих же задач с помощью API пакетной службы, командлетов PowerShell и портала Azure.

Azure CLI можно запустить в Azure Cloud Shell или установить Azure CLI локально. Версии доступны для операционных систем Windows, Mac и Linux (ОС).

В этой статье объясняется, как использовать Azure CLI с учетными записями Batch и ресурсами Batch.

Настройка Azure CLI

Выберите способ настройки Azure CLI:

Если вы не знакомы с azure CLI, ознакомьтесь с разделом "Начало работы с Azure CLI " перед продолжением работы.

Если вы ранее установили Azure CLI локально, обязательно обновите установку до последней версии.

Проверка подлинности с помощью Azure CLI

Чтобы использовать Azure CLI с пакетной службой, сначала войдите в учетную запись Azure, а затем войдите в учетную запись пакетной службы.

Вход в учетную запись Azure

Чтобы использовать Azure CLI, сначала войдите в свою учетную запись Azure. На этом шаге вы получите доступ к командам Azure Resource Manager, которые включают команды службы пакетного управления . Затем можно выполнить команды для управления учетными записями Batch, ключами, пакетами приложений и квотами.

Вы можете выполнить проверку подлинности учетной записи Azure в Azure CLI двумя способами. Чтобы выполнять команды самостоятельно, войдите в Azure CLI в интерактивном режиме. Azure CLI кэширует учетные данные и может использовать те же учетные данные для входа в учетную запись пакетной службы после этого. Чтобы выполнить команды из скрипта или приложения, войдите в Azure CLI, используя служебный принципал.

Чтобы войти в Azure CLI в интерактивном режиме, выполните следующую команду az login:

az login

Вход в Batch учетную запись

Затем войдите в учетную запись пакетной службы в Azure CLI с помощью команды az batch account login . Этот шаг предоставляет доступ к командам пакетной службы. Затем вы можете управлять ресурсами Batch, такими как пулы, работы и задачи.

Вы можете аутентифицировать свою учетную запись Batch в Azure CLI двумя способами. Метод по умолчанию — проверка подлинности с помощью идентификатора Microsoft Entra. Мы рекомендуем использовать этот метод в большинстве сценариев. Другой вариант — использовать проверку подлинности с общим ключом.

Если вы создаете скрипты Azure CLI для автоматизации команд пакетной службы, можно использовать любой метод проверки подлинности. В некоторых сценариях аутентификация с общим ключом может быть проще, чем создание служебного принципала.

Аутентификация с помощью Microsoft Entra ID

По умолчанию для проверки подлинности с помощью вашей учетной записи Batch используется Microsoft Entra ID. При входе в систему Azure CLI в интерактивном режиме или с помощью субъекта-службы можно использовать те же кэшированные учетные данные для входа в учетную запись Batch с помощью Microsoft Entra ID. Этот метод проверки подлинности также предлагает управление доступом на основе ролей Azure (Azure RBAC). При использовании Azure RBAC доступ пользователей зависит от назначенной роли, а не ключей учетных записей. Вам нужно управлять только ролями Azure, а не ключами учетных записей. Затем идентификатор Microsoft Entra обрабатывает доступ и проверку подлинности.

Чтобы войти в учетную запись Batch с помощью идентификатора Microsoft Entra, выполните az batch login. Обязательно включите необходимые параметры для имени учетной записи пакетной службы (-n) и имени группы ресурсов (-g).

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

Проверка подлинности с помощью общего ключа

Вы также можете использовать проверку подлинности общего ключа для входа в учетную запись Azure Batch. Этот метод использует ключи доступа к учетной записи для проверки подлинности команд Azure CLI для пакетной службы.

Чтобы войти в учетную запись Batch с помощью аутентификации Shared Key, выполните команду az batch login с параметром --shared-key-auth. Обязательно включите требуемые параметры для имени Batch-учетной записи (-n) и имени группы ресурсов (-g).

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

Изучите команды пакетной обработки

Справочная документация по Azure CLI содержит все команды Azure CLI для Batch.

Чтобы вывести список всех Batch команд в Azure CLI, выполните команду az batch -h.

Существует несколько примеров скриптов CLI для распространенных задач пакетной службы. В этих примерах показано, как использовать многие доступные команды для Batch в Azure CLI. Вы можете узнать, как создавать и управлять учетными записями службы Batch, пулами, заданиями и задачами.

Использование команд расширения пакетной командной строки (CLI)

Для выполнения заданий пакетной службы можно использовать расширение CLI пакетной службы без написания кода. Расширение предоставляет команды для использования шаблонов JSON для создания пулов, заданий и задач с помощью Azure CLI. Расширение также предоставляет команды для подключения к учетной записи хранения Azure, связанной с вашей учетной записью Batch. Затем можно передать и скачать входные файлы заданий.

Создание ресурсов с помощью JSON

Большинство ресурсов Batch можно создать, используя только параметры командной строки. Для некоторых функций требуется указать файл конфигурации JSON. JSON-файл содержит сведения о конфигурации нового ресурса. Например, необходимо использовать JSON-файл, чтобы указать файлы ресурсов для начальной задачи.

Например, чтобы использовать JSON-файл для настройки нового ресурса пула Batch:

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

При указании JSON-файла для нового ресурса не используйте другие параметры в команде. Служба использует только JSON-файл для настройки ресурса.

Справочная документация по REST API пакетной службы перечисляет любой синтаксис JSON, необходимый для создания ресурса.

Чтобы просмотреть синтаксис JSON, необходимый для создания ресурса, обратитесь к справочной документации по Batch REST API. Перейдите в раздел "Примеры" на странице справки по операции ресурса. Затем найдите подраздел с заголовком "Добавить <тип> ресурса". Например, добавьте базовую задачу. Используйте пример кода JSON в качестве шаблонов для файлов конфигурации.

Пример скрипта, указывающего JSON-файл, см. в разделе "Запуск задания и задач с помощью пакетной службы".

Эффективно запрашивать ресурсы для пакетных задач

Вы можете запросить учетную запись Batch и перечислить все ресурсы с помощью команды list. Например, чтобы перечислить пулы в учетной записи и задачи в работе:

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

Чтобы ограничить объем данных, возвращаемых пакетным запросом, укажите предложение OData. Все фильтрация выполняется на стороне сервера, поэтому вы получаете только запрашиваемые данные. Используйте эти условия OData для экономии пропускной способности и времени в операциях list. Для получения дополнительной информации см. в статье Создание эффективных запросов списков для ресурсов пакетов.

Clause Описание
--select-clause [select-clause] Возвращает подмножество свойств для каждой сущности.
--filter-clause [filter-clause] Возвращает только сущности, соответствующие указанному выражению OData.
--expand-clause [expand-clause] Получает сведения об одной сущности в базовом REST-запросе. В настоящее время оператор expand поддерживает только свойство stats.

Пример скрипта, демонстрирующего использование этих конструкций, см. в разделе "Запуск задания и задач с помощью службы Batch".

Устранение неполадок

Чтобы получить справку по любой batch-команде, добавьте -h в конец вашей команды. Не добавляйте другие параметры. Например, чтобы получить справку по созданию учетной записи Azure Batch, выполните команду az batch account create -h.

Чтобы вернуть подробные выходные данные команды, добавьте -v или -vv в конец команды. Используйте эти переключатели для отображения полного вывода ошибок. Флаг -vv возвращает фактические запросы и ответы REST.

Чтобы просмотреть выходные данные команды в формате JSON, добавьте --json в конец команды. Например, чтобы отобразить свойства пула с именем pool001, выполните команду az batch pool show pool001 --json. Затем скопируйте и измените выходные данные, чтобы создать ресурсы Batch с помощью файла конфигурации JSON.

Общие сведения об устранении неполадок с помощью Azure CLI

Azure CLI может выполняться в нескольких средах оболочки, но с небольшими вариантами формата. Если вы столкнулись с непредвиденными результатами команд Azure CLI, см. статью Как успешно использовать Azure CLI.

Дальнейшие действия

Краткое руководство. Запуск первого пакетного задания с помощью Azure CLI

  • Last updated on