azure.azcollection.azure_rm_adpassword – Управление паролем приложения
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_adpassword.
Впервые в версии 0.2.0: из azure.azcollection
Описание
- Управление паролем приложения.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. |
| app_id строка | Идентификатор приложения. | |
| app_object_id строка | Идентификатор объекта приложения. | |
| append_tags логическое |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. |
| auth_source строка добавлен в 0.0.1 azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также можно установить через переменную среды 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. |
| cert_validation_mode строка добавлен в 0.0.1 azure.azcollection |
| Управляет поведением проверки сертификатов для 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. |
| end_date строка | Дата или время, после которого учетные данные истекают. Значение по умолчанию — через год после текущего времени. | |
| key_id строка | Идентификатор ключа пароля. | |
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с помощью служебного принципала. | |
| service_principal_object_id строка | Идентификатор объекта служебного принципала. | |
| state строка |
| Утверждение состояния пароля Active Directory. Используйте present, чтобы создать или обновить пароль, и absent, чтобы удалить.Обновление не поддерживается. Если state=absent и key_id=None, все пароли приложения будут удалены. |
| subscription_id строка | Ваш идентификатор подписки Azure. | |
| tags словарь | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | |
| tenant строка / обязательно | Идентификатор клиента. | |
| value строка | Значение пароля приложения. Длина больше 18 символов. |
Примечания
Примечание
- Для аутентификации с 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 ad password
azure_rm_adpassword:
app_id: "{{ app_id }}"
state: present
value: "$abc12345678"
tenant: "{{ tenant_id }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| end_date строка | всегда | Дата или время, после которого учетные данные истекают. Значение по умолчанию — через год после текущего времени. Пример: 2021-06-28T06:00:32.637070+00:00 |
| key_id строка | всегда | Идентификатор ключа пароля Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| start_date строка | всегда | Дата или время, когда учетные данные становятся действительными. Значение по умолчанию — текущее время. Пример: 2020-06-28T06:00:32.637070+00:00 |
Авторы
- haiyuan_zhang (@haiyuazhang) Fred-sun (@Fred-sun)
© 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_adpassword_module.html