модуль azure.azcollection.azure_rm_aduser_info — получение сведений о пользователе Azure Active Directory
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS. |
all boolean | Если Если Рекомендуется вместо этого задать подмножество пользователей и использовать фильтр. Несовместим с object_id, attribute_name, odata_filter и user_principal_name. Варианты:
|
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
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 добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной окружения При значении При значении При значении При значении При значении Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Определяет поведение проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной окружения |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например, По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. При установке значения **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. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), непосредственно используемый для аутентификации с удостоверением рабочей нагрузки. Этот токен обменивается на токен Azure AD с помощью федеративного удостоверения OIDC. Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной окружения |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Файл должен содержать только токен в исходном виде. Этот способ часто используется на платформах, которые предоставляют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения |
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.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации с помощью субъекта-службы передайте 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: 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 | Указывает, включена ли учетная запись. Возвращается: всегда Пример: |
company_name string | Название компании, с которой связан пользователь. Возвращается: всегда Пример: |
display_name string | Отображаемое имя пользователя. Возвращается: всегда Пример: |
given_name string | Имя пользователя. Возвращается: всегда Пример: |
string | Основной адрес электронной почты пользователя. Возвращается: всегда Пример: |
mail_nickname string | Почтовый псевдоним пользователя. Возвращается: всегда Пример: |
mobile_phone string | Номер мобильного телефона пользователя. Возвращается: всегда Пример: |
object_id string | Идентификатор object_id пользователя. Возвращается: всегда Пример: |
on_premises_extension_attributes dictionary | Содержит extensionAttributes1-15 пользователя. Эти атрибуты расширения также известны как пользовательские атрибуты Exchange 1-15. Для пользователя с включенным onPremisesSyncEnabled источником полномочий для этого набора свойств является локальная среда, и эти свойства доступны только для чтения. Для пользователя, существующего только в облаке (где onPremisesSyncEnabled имеет значение false), эти свойства можно задать при создании или обновлении объекта пользователя. Для пользователя, существующего только в облаке и ранее синхронизированного из локальной Active Directory, эти свойства доступны только для чтения в Microsoft Graph/, но ими можно полностью управлять через Центр администрирования Exchange или модуль Exchange Online V2 для PowerShell. Возвращается: всегда Пример: |
surname string | Фамилия пользователя. Возвращается: всегда Пример: |
user_principal_name string | Имя участника-пользователя. Возвращается: всегда Пример: |
user_type string | Строковое значение, которое можно использовать для классификации типов пользователей в каталоге. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_aduser_info_module.html