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

Примечание

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

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

Для использования в плейбуке укажите: azure.azcollection.azure_rm_batchaccount.

Новое в версии 0.1.2: of azure.azcollection

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

Обзор

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

Требования

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

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-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags булево	Варианты: нет да ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. Когда каноническое, любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 azure.azcollection	Варианты: auto ← 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` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. The `msi` было добавлено в Ansible 2.6.
auto_storage_account строка		Существующая учетная запись хранения, с которой необходимо связать учетную запись Batch. Это может быть имя учетной записи хранения, которая находится в той же группе ресурсов. Это может быть идентификатор учетной записи хранения. Например, "/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 строка		Существующий хранилище ключей, которое необходимо связать с учетной записью Batch. Это может быть имя хранилища ключей, которое находится в той же группе ресурсов. Это может быть идентификатор хранилища ключей. Например, "/subscriptions/{subscription_id}/resourceGroups/ {resource_group}/providers/Microsoft.KeyVault/vaults/{name}". Это может быть словарь, содержащий поля name и resource_group хранилища ключей.
location строка		Указывает поддерживаемое расположение Azure, где существует ресурс.
name строка / обязательно		Имя учетной записи Batch.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала.
pool_allocation_mode строка	Варианты: batch_service ← user_subscription	Режим выделения пула учетной записи Batch.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов, в которой необходимо создать учетную запись Batch.
secret строка		Секрет клиента Azure. Используйте при аутентификации с сервисным принципалом.
state строка	Варианты: present ← absent	Утверждает состояние учетной записи Batch. Используйте `present` для создания или обновления учетной записи Batch и `absent` для её удаления.
subscription_id строка		Идентификатор вашей Azure подписки.
tags словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка		Идентификатор Azure-аренды. Используйте при аутентификации с сервисным принципалом.

Примечания

Примечание

Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или выполнить вход перед запуском задач или плейбука с помощью 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 строка	всегда	Конечная точка доступа к учетной записи Batch, используемая для взаимодействия с сервисом. Пример: sampleacct.westus.batch.azure.com
id строка	всегда	Идентификатор учетной записи Batch. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Batch/batchAccounts/sampleacct

Авторы

Junyi Yi (@JunyiYi)

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