Модуль azure.azcollection.azure_rm_automationaccount – Управление учетной записью Azure Automation
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_automationaccount.
Добавлен в azure.azcollection 0.1.2
Описание
- Создание и удаление учетной записи Azure Automation.
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- 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:
|
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:
|
location string | Расположение ресурса. Если не указано, используется расположение группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / required | Имя учетной записи автоматизации. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group строка / обязательно | Имя группы ресурсов. |
secret строка | Секретный ключ Azure. Используется при аутентификации с помощью Сервисного принципала. |
state строка | Состояние учетной записи автоматизации. Используйте Варианты:
|
subscription_id строка | Ваш идентификатор подписки Azure. |
tags словарь | Словарь пар строка:строка для назначения метаданных объекту. Метаданные метки объекта будут обновлены с предоставленными значениями. Для удаления меток установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах. |
tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с помощью Сервисного принципала. |
thumbprint строка добавлено в azure.azcollection 1.14.0 | Отпечаток цифрового сертификата для закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Сервисного принципала. Требуется, если определен x509_certificate_path. |
x509_certificate_path путь добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания сервисного принципала в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью Сервисного принципала. |
Примечания
Примечание
- Для аутентификации с 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. Также возможно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.
См. также
См. также
- Войти с помощью Azure CLI
-
Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: Create an automation account
azure_rm_automationaccount:
name: Testing
resource_group: myResourceGroup
- name: Create an automation account
azure_rm_automationaccount:
name: Testing
resource_group: myResourceGroup
location: eastus
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
id строка | Идентификатор ресурса учетной записи автоматизации. Возвращается: успех Пример: |
Ссылки на сборку
© 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_automationaccount_module.html