azure.azcollection.azure_rm_adserviceprincipal_info – Получение информации о службе Azure Active Directory

Примечание

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

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_adserviceprincipal_info.

Новое в версии 0.2.0: из azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Получение информации о службе Azure Active Directory.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

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 строка		Идентификатор приложения.
append_tags логическое	Варианты: нет да ←	Управляет тем, будет ли поле тегов каноническим или просто добавляться к существующим тегам. Когда каноническое, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 azure.azcollection	Варианты: авто ← 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 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для 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`.
object_id строка		Идентификатор объекта службы.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
secret строка		Секрет клиента Azure. Используйте при аутентификации с помощью службы.
subscription_id строка		Идентификатор вашей подписки Azure.
tags словарь		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные-теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false.
tenant строка / обязательно		Идентификатор клиента.

Примечания

Примечание

Для аутентификации с 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: get ad sp info
  azure_rm_adserviceprincipal_info:
    app_id: "{{ app_id }}"
    tenant: "{{ tenant_id }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Возвращаемое значение	Описание
app_display_name строка	всегда	Отображаемое имя объекта или его префикс. Пример: sp
app_id строка	всегда	Идентификатор приложения. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
app_role_assignment_required логическое	всегда	Установлен ли Роль службы.
object_id строка	всегда	Идентификатор объекта службы. Пример: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Авторы

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_adserviceprincipal_info_module.html