azure.azcollection.azure_rm_adpassword – Управление паролем приложения

Примечание

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

Для его установки используйте: 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 of azure.azcollection		URL-адрес полномочий Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственных полномочий ADFS.
api_profile строка добавлено в 0.0.1 of azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
app_id строка		Идентификатор приложения.
app_object_id строка		Идентификатор объекта приложения.
append_tags логическое	Варианты: no yes ←	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. Если каноническое, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 of 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` может использоваться для идентификации идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` было добавлено в Ansible 2.6.
cert_validation_mode строка добавлено в 0.0.1 of azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификата для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
cloud_environment строка добавлено в 0.0.1 of 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 строка	Варианты: absent present ←	Утверждение состояния пароля 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–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_adpassword_module.html