azure.azcollection.azure_rm_batchaccount – Управляет учетной записью пакетной обработки в Azure

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_batchaccount.

Введено в версии 0.1.2: коллекции azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Создание, обновление и удаление экземпляра учетной записи пакетной обработки Azure.

Требования

Ниже перечислены требования, которые необходимы на хосте, выполняющем этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
adfs_authority_url строка добавлен в 0.0.1 коллекции azure.azcollection		URL авторитета Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственном авторитете ADFS.
api_profile строка добавлен в 0.0.1 коллекции azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure services. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags булево	Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 коллекции azure.azcollection	Варианты: авто ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. Когда задано `auto` (значение по умолчанию) приоритет — параметры модуля -> `env` -> `credential_file` -> `cli`. Когда установлено `env`, учетные данные будут считываться из переменных среды. Когда установлено `credential_file`, будет считываться профиль из `~/.azure/credentials`. Когда установлено `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az cli. Когда установлено `msi`, хост-машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
auto_storage_account строка		Существующая учетная запись хранилища, с которой следует связать учетную запись пакетной обработки. Это может быть имя учетной записи хранилища, находящейся в той же группе ресурсов. Это может быть идентификатор учетной записи хранилища. Например, "/subscriptions/{subscription_id}/resourceGroups/ {resource_group}/providers/Microsoft.Storage/storageAccounts/{name}". Это может быть словарь, содержащий поля name и resource_group учетной записи хранилища.
cert_validation_mode строка добавлен в 0.0.1 коллекции azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или подключения к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала.
cloud_environment строка добавлен в 0.0.1 коллекции azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки входа в обнаружение метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
key_vault строка		Существующий хранилище ключей, с которым следует связать учетную запись пакетной обработки. Это может быть имя хранилища ключей, находящегося в той же группе ресурсов. Это может быть идентификатор хранилища ключей. Например, "/subscriptions/{subscription_id}/resourceGroups/ {resource_group}/providers/Microsoft.KeyVault/vaults/{name}". Это может быть словарь, содержащий поля name и resource_group хранилища ключей.
location строка		Указывает поддерживаемое местоположение Azure, где существует ресурс.
name строка / обязательно		Имя учетной записи пакетной обработки.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
pool_allocation_mode строка	Варианты: batch_service ← user_subscription	Режим распределения пула учетной записи пакетной обработки.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов, в которой нужно создать учетную запись пакетной обработки.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала.
state строка	Варианты: present ← absent	Утверждает состояние учетной записи пакетной обработки. Используйте `present` для создания или обновления учетной записи пакетной обработки и `absent` для ее удаления.
subscription_id строка		Идентификатор вашей подписки Azure.
tags словарь		Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в false.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с помощью службы-принципала.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед выполнением задач или playbook с az login.
Аутентификация также возможна с помощью службы-принципала или пользователя Active Directory.
Для аутентификации через службу-принципал передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные могут храниться в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Вход в Azure CLI: Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Create Batch Account
  azure_rm_batchaccount:
      resource_group: MyResGroup
      name: mybatchaccount
      location: eastus
      auto_storage_account:
        name: mystorageaccountname
      pool_allocation_mode: batch_service

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
account_endpoint string	всегда	Конечная точка учетной записи, используемая для взаимодействия с сервисом Batch. Пример: sampleacct.westus.batch.azure.com
id string	всегда	Идентификатор учетной записи Batch. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Batch/batchAccounts/sampleacct

Авторы

Junyi Yi (@JunyiYi)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_batchaccount_module.html