azure_rm_automationaccount – Управление учетной записью Azure Automation
Новая в версии 2.9.
Обзор
- Создание и удаление учетной записи Azure Automation.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| adfs_authority_url строка добавлено в 2.6 | URL-адрес полномочий Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службы ADFS. | |
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags булево |
| Управление тем, является ли поле тегов каноническим или просто добавляет теги к существующим. В случае канонического значения любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source строка добавлено в 2.5 |
| Управление источником учетных данных для аутентификации. Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE, которая по умолчанию равна auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.
При значении cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При значении msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может быть использована для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка.msi было добавлено в Ansible 2.6. |
| cert_validation_mode строка добавлено в 2.5 |
| Управление проверкой сертификатов для Azure-конечных точек. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или в случае с Azure Stack может потребоваться отключить эту функцию, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| cloud_environment строка добавлено в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| location строка | Расположение ресурса. Если не указано, используется расположение группы ресурсов. | |
| name строка / обязательно | Имя учетной записи Automation. | |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| profile строка | Профиль безопасности, находящийся в файле ~/.azure/credentials. | |
| resource_group строка / обязательно | Имя группы ресурсов. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| state строка |
| Состояние учетной записи Automation. Используйте present для создания или обновления учетной записи Automation и absent для удаления учетной записи Automation. |
| 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 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 строка | успех | Идентификатор ресурса учетной записи Automation. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Yuwei Zhou (@yuwzho)
Подсказка
Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_automationaccount_module.html