Модуль azure.azcollection.azure_rm_aduser — Модификация пользователя 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.

Новое в azure.azcollection 1.5.0

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

Обзор

Создание, удаление и обновление пользователя Azure Active Directory.

Требования

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

python >= 2.7
На хосте, который выполняет этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
Все пакеты Python, перечисленные в requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection.
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
account_enabled boolean	Логическое значение, определяющее, включена ли учетная запись пользователя. Используется при создании или обновлении учетной записи пользователя. Выбираемые значения: `false` `true`
ad_user string	Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
adfs_authority_url string добавлено в azure.azcollection 0.0.1	URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственного авторитета ADFS.
api_profile string добавлено в 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. Требуется вместе с attribute_value.
attribute_value string	Значение для сопоставления с attribute_name. Если attribute_name не является типом коллекции, он обновит или удалит пользователя, где attribute_name равен attribute_value. Если attribute_name является типом коллекции, он обновит или удалит пользователя, где attribute_value содержится в attribute_name. Требуется вместе с attribute_name.
...

END_OF_DOCUMENT_MARKER

given_name string	Имя пользователя. Используется при создании или обновлении учетной записи пользователя.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
mail string	Основной адрес электронной почты пользователя. Используется при создании или обновлении учетной записи пользователя.
mail_nickname string	Псевдоним адреса электронной почты пользователя. Используется при создании или обновлении учетной записи пользователя.
mobile_phone string	Номер мобильного телефона пользователя. Используется при создании или обновлении учетной записи пользователя.
object_id string	Идентификатор объекта пользователя. Обновляет или удаляет пользователя с этим идентификатором объекта. Исключительно с user_principal_name, attribute_name и odata_filter.
odata_filter string	Фильтр, который может быть использован для указания пользователя для обновления или удаления. Исключительно с object_id, attribute_name и user_principal_name.
on_premises_extension_attributes aliases: extension_attributes dictionary	Содержит extensionAttributes1-15 для пользователя. Эти расширенные атрибуты также известны как настраиваемые атрибуты Exchange 1-15. Для пользователя onPremisesSyncEnabled источником данных для этого набора свойств является локальная система и он является только для чтения. Для пользователя только в облаке (где onPremisesSyncEnabled false), эти свойства можно задать во время создания или обновления объекта пользователя. Для пользователя в облаке, ранее синхронизированного с локальной Active Directory, эти свойства являются только для чтения в Microsoft Graph, но могут быть полностью управляемы через Центр администрирования Exchange или модуль Exchange Online V2 в PowerShell.
on_premises_immutable_id aliases: immutable_id string	on_premises_immutable_id пользователя. Используется при создании или обновлении учетной записи пользователя.
password string	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала.
password_force_change boolean	Требуется ли изменение пароля пользователем при следующей попытке входа. Если не указано, Azure по умолчанию устанавливает это значение в true для новых пользователей. Используется при создании или обновлении учетной записи пользователя. Варианты: `false` `true`
password_force_change_mfa boolean	Поведение идентично password_force_change, за исключением того, что перед изменением пароля необходимо выполнить двухфакторную аутентификацию (MFA). Используется при создании или обновлении учетной записи пользователя. Варианты: `false` `true`
password_profile string	Пароль пользователя. Используется при создании или обновлении учетной записи пользователя.
profile string	Профиль безопасности, находящийся в файле ~/.azure/credentials.
secret string	Секрет Azure-клиента. Используется при аутентификации с помощью сервисного принципала.
state string	Состояние пользователя ad. Используется для создания или обновления пользователя ad и для удаления пользователя ad. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id string	Идентификатор вашей Azure-подписки.
surname string	Фамилия пользователя. Используется при создании или обновлении учетной записи пользователя.
tenant string	Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала.
thumbprint string добавлено в azure.azcollection 1.14.0	Отпечаток цифрового сертификата, указанный в x509_certificate_path. Используется при аутентификации с помощью сервисного принципала. Требуется, если определен x509_certificate_path.

END_OF_DOCUMENT_MARKER

usage_location string	Код страны из двух букв, стандарт ISO 3166. Требуется для пользователя, которому будут назначены лицензии, из-за юридического требования проверки доступности услуг в странах. Используется при создании или обновлении учетной записи пользователя.
user_principal_name string	Основное имя пользователя. Создаёт, обновляет или удаляет пользователя с этим основным именем. Взаимоисключающие параметры с object_id, attribute_name и odata_filter.
user_type string	Строковое значение, которое может использоваться для классификации типов пользователей в вашем каталоге, например, «Член» и «Гость». Используется при создании или обновлении учетной записи пользователя.
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 в среде.

См. также

Вход с помощью Azure CLI: Как войти в систему, используя команду az login.

Примеры

- name: Create user
  azure_rm_aduser:
    user_principal_name: "{{ user_id }}"
    state: "present"
    account_enabled: "True"
    display_name: "Test_{{ user_principal_name }}_Display_Name"
    password_profile: "password"
    mail_nickname: "Test_{{ user_principal_name }}_mail_nickname"
    on_premises_immutable_id: "{{ object_id }}"
    given_name: "First"
    surname: "Last"
    user_type: "Member"
    usage_location: "US"
    mail: "{{ user_principal_name }}@contoso.com"
    mobile_phone: "+1234567890123"
    company_name: 'Test Company'
    on_premises_extension_attributes:
      extension_attribute1: "test_extension_attribute1"
      extension_attribute2: "test_extension_attribute2"
      extension_attribute11: "test_extension_attribute11"

- name: Update user with new value for account_enabled
  azure_rm_aduser:
    user_principal_name: "{{ user_id }}"
    state: "present"
    account_enabled: "False"

- name: Delete user
  azure_rm_aduser:
    user_principal_name: "{{ user_id }}"
    state: "absent"

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

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

Ключ	Описание
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	object_id пользователя. Возвращается: всегда Пример: `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
on_premises_extension_attributes dictionary	Содержит расширенные атрибуты 1-15 для пользователя. Эти расширенные атрибуты также известны как пользовательские атрибуты Exchange 1-15. Для пользователя с включенной синхронизацией с локальной системой источник данных для этого набора свойств — локальная система, и он является только для чтения. Для облачного пользователя (когда onPremisesSyncEnabled — false) эти свойства можно задать во время создания или обновления объекта пользователя. Для облачного пользователя, ранее синхронизированного с локальной Active Directory, эти свойства в Microsoft Graph являются только для чтения, но их можно полностью управлять через Exchange Admin Center или модуль 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_module.html