Модуль azure.azcollection.azure_rm_batchaccount — Управление учетной записью Azure Batch
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_batchaccount.
Добавлена в azure.azcollection 0.1.2
Описание
- Создание, обновление и удаление экземпляра учетной записи Azure Batch.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
- Все пакеты Python, перечисленные в requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection.
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
append_tags boolean | Используйте для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлено через переменную среды При установке в При установке в При установке в При установке в При установке в
Choices:
|
auto_storage_account any | Существующий аккаунт хранения, с которым следует связать аккаунт Batch. Это может быть имя учетной записи хранения, которая находится в той же группе ресурсов. Это может быть идентификатор учетной записи хранения. Например, “/subscriptions/{subscription_id}/resourceGroups/ {resource_group}/providers/Microsoft.Storage/storageAccounts/{name}”. Это может быть словарь, который содержит name и resource_group учетной записи хранения. |
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлено через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате крайне важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
identity dictionary added in azure.azcollection 2.5.0 | Идентификатор для этого ресурса. |
|
type string |
Тип управляемой идентичности Choices:
|
|
user_assigned_identity string |
Управляемая идентичность, назначенная пользователем, связанная с этим ресурсом |
key_vault any | Существующий хранилище ключей, с которым необходимо связать учетную запись Batch. Это может быть имя хранилища ключей, которое находится в той же группе ресурсов. Это может быть ID хранилища ключей. Например, “/subscriptions/{subscription_id}/resourceGroups/ {resource_group}/providers/Microsoft.KeyVault/vaults/{name}”. Это может быть словарь, содержащий name и resource_group хранилища ключей. |
location string | Указывает поддерживаемое местоположение Azure, где существует ресурс. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / required | Имя учетной записи Batch. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
pool_allocation_mode string | Режим распределения пула учетной записи Batch. Варианты:
|
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / required | Имя группы ресурсов, в которой необходимо создать учетную запись Batch. |
secret string | Секретный ключ клиента Azure. Используется при аутентификации с помощью субъекта безопасности. |
state string | Утверждает состояние учетной записи Batch. Используйте Варианты:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tags dictionary | Словарь пар строка:строка для присваивания в качестве метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использования пробелов в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов. |
tenant string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности. |
thumbprint string added in azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью субъекта безопасности. Обязательно, если определен x509_certificate_path. |
x509_certificate_path path added in azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания субъекта безопасности в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью субъекта безопасности. |
Примечания
Примечание
- Для аутентификации с 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 строка | Конечная точка учетной записи, используемая для взаимодействия с сервисом Batch. Возвращается: всегда Пример: |
id строка | Идентификатор учетной записи Batch. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_batchaccount_module.html