Модуль azure.azcollection.azure_rm_aduser_info – Получение информации о пользователе Azure Active Directory

Примечание

Этот модуль входит в состав коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

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

Добавлена в azure.azcollection 1.4.0

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

Описание

Получение информации о пользователе Azure Active Directory.

Требования

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

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.
all boolean	Если `True`, вернет всех пользователей в клиенте. Если `False` вернет ни одного пользователя. Рекомендуется вместо этого определить подмножество пользователей и использовать фильтр. Взаимоисключающий с object_id, attribute_name, odata_filter и user_principal_name. Варианты: `false` `true`
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
attribute_name string	Имя атрибута, который вы хотите сопоставить с attribute_value. Если attribute_name не является типом коллекции, он вернет пользователей, у которых attribute_name равен attribute_value. Если attribute_name является типом коллекции, он вернет пользователей, у которых attribute_value находится в attribute_name. Взаимоисключающий с object_id, user_principal_name, odata_filter и all. Обязательно вместе с attribute_value.
attribute_value string	Значение для сопоставления с attribute_name. Если attribute_name не является типом коллекции, он вернет пользователей, у которых attribute_name равен attribute_value. Если attribute_name является типом коллекции, он вернет пользователей, у которых attribute_value находится в attribute_name. Обязательно вместе с attribute_name.
auth_source string added in azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Также может быть установлен через переменную среды `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. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает извлечение метаданных центра проверки подлинности из https://login.microsoft.com/ для проверки центра проверки подлинности. Установив это значение в True, проверка центра проверки подлинности отключается. В результате важно убедиться, что настроенный хост центра проверки подлинности является допустимым и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.

object_id string	Идентификатор объекта пользователя. Возвращает пользователя с этим идентификатором объекта. Взаимоисключительно с user_principal_name, attribute_name, odata_filter и all.
odata_filter string	Возвращает пользователей, соответствующих OData фильтру, переданному в этот параметр. Взаимоисключительно с object_id, attribute_name, user_principal_name и all.
password string	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
secret string	Секрет Azure клиента. Используется при аутентификации с сервисным принципалом.
subscription_id string	Идентификатор вашей подписки Azure.
tenant string	Идентификатор Azure-тенанта. Используется при аутентификации с сервисным принципалом.
thumbprint string добавлен в azure.azcollection 1.14.0	Отпечаток пальца закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с сервисным принципалом. Требуется, если определен x509_certificate_path.
user_principal_name string	Имя принципала пользователя. Возвращает пользователя с этим именем принципала. Взаимоисключительно с object_id, attribute_name, odata_filter и all.
x509_certificate_path 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. Также возможно добавление дополнительных профилей. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Примеры

- name: Using user_principal_name
  azure.azcollection.azure_rm_aduser_info:
    user_principal_name: user@contoso.com

- name: Using object_id
  azure.azcollection.azure_rm_aduser_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Using attribute mailNickname - not a collection
  azure.azcollection.azure_rm_aduser_info:
    attribute_name: mailNickname
    attribute_value: users_mailNickname

- name: Using attribute proxyAddresses - a collection
  azure.azcollection.azure_rm_aduser_info:
    attribute_name: proxyAddresses
    attribute_value: SMTP:user@contoso.com

- name: Using Filter mailNickname
  azure.azcollection.azure_rm_aduser_info:
    odata_filter: mailNickname eq 'user@contoso.com'

- name: Using Filter proxyAddresses
  azure.azcollection.azure_rm_aduser_info:
    odata_filter: proxyAddresses/any(c:c eq 'SMTP:user@contoso.com')

Значения возврата

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

Ключ	Описание
account_enabled boolean	Включена ли учетная запись. Возвращается: всегда Пример: `false`
company_name string	Название компании, с которой ассоциирован пользователь. Возвращается: всегда Пример: `"Test Company"`
display_name string	Используемое имя пользователя. Возвращается: всегда Пример: `"John Smith"`
mail string	Основной адрес электронной почты пользователя. Возвращается: всегда Пример: `"John.Smith@contoso.com"`
mail_nickname string	Псевдоним адреса электронной почты пользователя. Возвращается: всегда Пример: `"jsmith"`
mobile_phone string	Номер мобильного телефона пользователя. Возвращается: всегда Пример: `"+1234567890123"`
object_id string	Идентификатор объекта пользователя. Возвращается: всегда Пример: `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
on_premises_extension_attributes dictionary	Содержит расширенные атрибуты 1-15 для пользователя. Эти расширенные атрибуты также известны как пользовательские атрибуты Exchange 1-15. Для пользователя с onPremisesSyncEnabled источником данных для этого набора свойств являются локальные данные, и он является только для чтения. Для чисто облачного пользователя (где onPremisesSyncEnabled ложно), эти свойства могут быть установлены во время создания или обновления объекта пользователя. Для чисто облачного пользователя, ранее синхронизированного с локальной Active Directory, эти свойства являются только для чтения в Microsoft Graph, но могут быть полностью управляемы через Центр администрирования Exchange или модуль Exchange Online V2 в PowerShell. Возвращается: всегда Пример: `{}`
user_principal_name string	Основное имя пользователя. Возвращается: всегда Пример: `"jsmith@contoso.com"`
user_type string	Строковое значение, которое можно использовать для классификации типов пользователей в каталоге. Возвращается: всегда Пример: `"Member"`

Авторы

Кол Неубауэр(@coleneubauer)

Ссылки на сборку

© 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_aduser_info_module.html