Управление ресурсами пакетной службы с помощью Azure CLI
Вы можете управлять учетными записями и ресурсами Пакетной службы Azure с помощью интерфейса командной строки Azure (Azure CLI). В вашем распоряжении команды для создания и обновления ресурсов Пакетной службы, таких как пулы, задания и задачи. Кроме того, вы можете создавать скрипты для многих задач, выполняемых с помощью API-интерфейсов Пакетной службы, командлетов PowerShell и портала Azure.
Вы можете запустить Azure CLI в Azure Cloud Shell или установить Azure CLI локально. Версии доступны для операционных систем (ОС) Windows, Mac и Linux.
В этой статье объясняется, как использовать Azure CLI с учетными записями и ресурсами Пакетной службы.
Настройка Azure CLI
Выберите способ настройки Azure CLI:
- Запуск Azure CLI в Cloud Shell.
- Установка Azure CLI в локальной среде:
- установка Azure CLI в Windows;
- установка Azure CLI в macOS;
- установка Azure CLI в Linux для нескольких дистрибутивов Linux.
Если вы еще не работали с Azure CLI, перед продолжением ознакомьтесь со статьей Начало работы с Azure CLI.
Если вы ранее установили Azure CLI локально, обязательно обновите установку до последней версии.
Проверка подлинности с помощью Azure CLI
Чтобы использовать Azure CLI с Пакетной службой, сначала войдите в учетную запись Azure, а затем войдите в учетную запись Пакетной службы.
Вход в учетную запись Azure
Чтобы использовать Azure CLI, сначала войдите в свою учетную запись Azure. Это позволит получить доступ к командам Azure Resource Manager, в том числе к командам службы управления Пакетной службой. Затем вы можете выполнять команды для управления учетными записями ключами, пакетами приложений и квотами Пакетной службы.
Вы можете выполнить проверку подлинности учетной записи Azure в Azure CLI двумя способами. Чтобы выполнить команды самостоятельно, войдите в Azure CLI в интерактивном режиме. Azure CLI кэширует учетные данные и может использовать их для последующего входа в учетную запись Пакетной службы. Чтобы выполнить команды из скрипта или приложения, войдите в Azure CLI с использованием субъекта-службы.
Чтобы войти в Azure CLI в интерактивном режиме, выполните следующую команду az login:
az login
Вход в учетную запись Пакетной службы
Затем войдите в учетную запись Пакетной службы в Azure CLI с помощью команды az batch account login. Этот шаг предоставляет доступ к командам Пакетной службы. Затем вы можете управлять такими ресурсами Пакетной службы, как пулы, задания и задачи.
Вы можете выполнить проверку подлинности учетной записи Пакетной службы в Azure CLI двумя способами. Метод по умолчанию — проверка подлинности с помощью идентификатора Microsoft Entra. Рекомендуем использовать этот метод в большинстве сценариев. Другой вариант — использовать проверку подлинности с применением общего ключа.
При создании скриптов Azure CLI для автоматизации команд Пакетной службы можно использовать любой из этих методов проверки подлинности. В некоторых случаях проверку подлинности на основе общего ключа реализовать проще, чем создать субъект-службу.
Проверка подлинности в Microsoft Entra ID
По умолчанию для проверки подлинности с помощью учетной записи пакетной службы используется идентификатор Microsoft Entra. При входе в Azure CLI в интерактивном режиме или с помощью субъекта-службы можно использовать те же кэшированные учетные данные для входа в учетную запись пакетной службы с помощью идентификатора Microsoft Entra. Кроме того, этот метод проверки подлинности обеспечивает управление доступом на основе ролей Azure (Azure RBAC). При использовании Azure RBAC доступ пользователя зависит от назначенной ему роли, а не от ключей учетной записи. Вам нужно управлять только ролями Azure, а не ключами учетных записей. Затем идентификатор Microsoft Entra обрабатывает доступ и проверку подлинности.
Чтобы войти в учетную запись пакетной службы с помощью идентификатора Microsoft Entra, выполните команду az batch login. Обязательно включите обязательные параметры для имени учетной записи Пакетной службы (-n) и имени группы ресурсов (-g).
az batch account login -g <your-resource-group> -n <your-batch-account>
Проверка подлинности с использованием общего ключа
Кроме того, для входа в учетную запись пакетной службы вы можете использовать проверку подлинности на основе общего ключа. При использовании этого метода проверка подлинности команд Azure CLI для Пакетной службы выполняется на основе ключей доступа к учетной записи.
Чтобы войти в учетную запись Пакетной службы с использованием проверки подлинности на основе общего ключа, выполните команду az batch login с параметром --shared-key-auth. Обязательно включите обязательные параметры для имени учетной записи Пакетной службы (-n) и имени группы ресурсов (-g).
az batch account login -g <your-resource-group> -n <your-batch-account> --shared-key-auth
Изучение команд Пакетной службы
Справочная документация по Azure CLI содержит все команды Azure CLI для Пакетной службы.
Чтобы вывести список всех команд Пакетной службы в Azure CLI, выполните команду az batch -h.
Есть несколько примеров скриптов CLI для распространенных задач Пакетной службы. В этих примерах показано, как использовать множество доступных команд для Пакетной службы в Azure CLI. Вы можете узнать, как создавать учетные записи, пулы, задания и задачи Пакетной службы, а также управлять ими.
Использование команд расширения CLI для Пакетной службы
С помощью расширения CLI Пакетной службы можно выполнять задания Пакетной службы без написания кода. Расширение предоставляет команды для использования шаблонов JSON для создания пулов, заданий и задач с помощью Azure CLI. Кроме того, расширение предоставляет команды для подключения к учетной записи Службы хранилища Azure, связанной с учетной записью Пакетной службы. После этого можно отправлять и скачивать входные файлы заданий.
Создание ресурсов с помощью JSON
Большинство ресурсов пакетной службы можно создавать только с помощью параметров командной строки. Для некоторых функций требуется указать JSON-файл конфигурации. JSON-файл содержит сведения о конфигурации для нового ресурса. Например, JSON-файл позволяет указать файлы ресурсов для задачи запуска.
Например, чтобы настроить новый ресурс пула Пакетной службы с помощью JSON-файла, сделайте следующее:
az batch pool <your-batch-pool-configuration>.json
При указании JSON-файла для нового ресурса не используйте другие параметры в команде. Для настройки ресурса служба использует только JSON-файл.
В справочной документации по REST API Пакетной службы можно найти любой синтаксис JSON, требуемый для создания ресурса.
Синтаксис JSON, необходимый для создания ресурса, см. в справочной документации по REST API пакетной службы. Перейдите к разделу Примеры на странице справки по операции ресурса. Затем найдите подраздел с названием Добавить <тип ресурса>. Например, Add a basic task (Добавить базовую задачу). Используйте пример кода JSON в качестве шаблонов для файлов конфигурации.
Пример скрипта указания файла JSON см. в статье Выполнение заданий в пакетной службе Azure с помощью Azure CLI.
Эффективное выполнение запросов к ресурсам Пакетной службы
Вы можете обратиться к учетной записи Пакетной службы и вывести список всех ресурсов с помощью команды list. Например, чтобы получить список пулов в учетной записи и задач, входящих в задание, сделайте следующее:
az batch pool list
az batch task list --job-id <your-job-id>
Чтобы ограничить объем данных, возвращаемых запросом к Пакетной службе, укажите предложение OData. Вся фильтрация выполняется на стороне сервера, поэтому вы получаете только запрашиваемые данные. Используйте эти предложения OData для экономии пропускной способности и времени с помощью операций list. Дополнительные сведения см. в статье Проектирование эффективных запросов на перечисление для ресурсов Пакетной службы.
| Предложение | Description |
|---|---|
--select-clause [select-clause] |
Возвращает подмножество свойств для каждой сущности. |
--filter-clause [filter-clause] |
Возвращает только те сущности, которые соответствуют указанному выражению OData. |
--expand-clause [expand-clause] |
Получает сведения о сущности за один базовый вызов REST. Сейчас предложение expand поддерживает только свойство stats. |
Пример скрипта, демонстрирующий использование этих предложений, см. в статье Выполнение заданий и задач с помощью Пакетной службы.
Устранение неполадок
Чтобы получить справку по любой команде Пакетной службы, добавьте -h в конец команды. Не добавляйте другие параметры. Например, чтобы получить справку по созданию учетной записи Пакетной службы, выполните команду az batch account create -h.
Чтобы получить подробные выходные данные команды, добавьте -v или -vv в конец команды. Используйте эти переключатели, чтобы отобразить полные выходные данные ошибок. Флаг -vv возвращает фактические запросы и ответы REST.
Чтобы просмотреть выходные данные команды в формате JSON, добавьте --json в конец команды. Например, чтобы отобразить свойства пула с именем pool001, выполните команду az batch pool show pool001 --json. Затем скопируйте и измените выходные данные, чтобы создать ресурсы Пакетной службы с помощью JSON-файла конфигурации.
Общие сведения об устранении неполадок с помощью Azure CLI
Azure CLI может выполняться в нескольких средах оболочки, но с небольшими вариантами формата. Если вы столкнулись с непредвиденными результатами команд Azure CLI, см. статью Как успешно использовать Azure CLI.