модуль azure.azcollection.azure_rm_aduser — изменение пользователя Azure Active Directory

account_enabled

логическое значение

Логическое значение, определяющее, включена ли учетная запись пользователя.

Используется при создании или обновлении учетной записи пользователя.

Варианты:

• false
• true

ad_user

строка

Имя пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

строка

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используется для аутентификации с помощью имени пользователя и пароля при наличии собственного центра ADFS.

api_profile

строка

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

attribute_name

строка

Имя атрибута, значение которого требуется сопоставить с 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

строка

Значение для сопоставления с attribute_name.

Если attribute_name не является типом коллекции, пользователь будет обновлен или удален, если значение attribute_name равно attribute_value.

Если attribute_name является типом коллекции, пользователь будет обновлен или удален, если attribute_value содержится в attribute_name.

Требуется указать вместе с attribute_name.

auth_source

строка

добавлено в 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; в противном случае будет использоваться подписка Azure CLI по умолчанию.

Если задано значение msi, узел должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

строка

добавлено в azure.azcollection 0.0.1

Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CERT_VALIDATION.

Варианты:

• "ignore"
• "validate"

client_id

строка

Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

строка

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, — имя среды (определенное в Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

company_name

строка

Название компании, с которой связан пользователь.

Это свойство может быть полезно для указания компании, из которой пришел внешний пользователь.

Максимальная длина — 64 символа. Возвращается только при использовании $select.

Поддерживает $filter (eq, ne, not, ge, le, in, startsWith, а также eq для значений null).

disable_instance_discovery

логическое значение

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Значение true полностью отключает обнаружение экземпляра и проверку центра. Эта возможность предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. В процессе обнаружения экземпляра метаданные центра извлекаются с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

• false ← (по умолчанию)
• true

display_name

строка

Отображаемое имя пользователя.

Используется при создании или обновлении учетной записи пользователя.

given_name

строка

Имя пользователя.

Используется при создании или обновлении учетной записи пользователя.

log_mode

строка

Родительский аргумент.

log_path

строка

Родительский аргумент.

mail

строка

Основной адрес электронной почты пользователя.

Используется при создании или обновлении учетной записи пользователя.

mail_nickname

строка

Почтовый псевдоним пользователя.

Используется при создании или обновлении учетной записи пользователя.

mobile_phone

строка

Номер мобильного телефона пользователя.

Используется при создании или обновлении учетной записи пользователя.

object_id

строка

Идентификатор объекта пользователя.

Обновляет или удаляет пользователя с этим идентификатором объекта.

Не может использоваться одновременно с user_principal_name, attribute_name и odata_filter.

odata_filter

строка

Фильтр для указания пользователя, которого требуется обновить или удалить.

Не может использоваться одновременно с object_id, attribute_name и user_principal_name.

oidc_token

строка

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD посредством федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

путь

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только исходный токен.

Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

on_premises_extension_attributes

псевдонимы: extension_attributes

словарь

Содержит атрибуты extensionAttributes1–15 пользователя.

Эти атрибуты расширения также известны как пользовательские атрибуты Exchange 1–15.

Для пользователя с включенной синхронизацией с локальной средой (onPremisesSyncEnabled) источником достоверных данных для этого набора свойств является локальная среда; свойства доступны только для чтения.

Для пользователя, работающего только в облаке (onPremisesSyncEnabled имеет значение false), эти свойства можно задать при создании или обновлении объекта пользователя.

Для пользователя, работающего только в облаке и ранее синхронизированного из локальной среды Active Directory, эти свойства доступны только для чтения в Microsoft Graph, но ими можно полностью управлять через Центр администрирования Exchange или модуль Exchange Online V2 в PowerShell.

on_premises_immutable_id

псевдонимы: immutable_id

строка

Значение on_premises_immutable_id пользователя.

Используется при создании или обновлении учетной записи пользователя.

password

строка

Пароль пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

password_force_change

логическое значение

Определяет, потребуется ли пользователю сменить пароль при следующем входе в систему.

Если значение не указано, Azure устанавливает для новых пользователей значение true.

Используется при создании или обновлении учетной записи пользователя.

Варианты:

• false
• true

password_force_change_mfa

логическое значение

Работает так же, как password_force_change, но перед сменой пароля необходимо пройти многофакторную аутентификацию (MFA).

Используется при создании или обновлении учетной записи пользователя.

Варианты:

• false
• true

password_profile

строка

Пароль пользователя.

Используется при создании или обновлении учетной записи пользователя.

profile

строка

Профиль безопасности из файла ~/.azure/credentials.

secret

строка

Секрет клиента Azure. Используется для аутентификации с помощью субъекта-службы.

state

строка

Состояние пользователя AD. Используйте present для создания или обновления пользователя AD и absent для его удаления.

Варианты:

• "absent"
• "present" ← (по умолчанию)

subscription_id

строка

Идентификатор вашей подписки Azure.

surname

строка

Фамилия пользователя.

Используется при создании или обновлении учетной записи пользователя.

tenant

строка

Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы.

thumbprint

строка

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется для аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

usage_location

строка

Двухбуквенный код страны по стандарту ISO 3166.

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

Используется при создании или обновлении учетной записи пользователя.

user_principal_name

строка

Имя участника-пользователя.

Создает, обновляет или удаляет пользователя с этим именем участника.

Не может использоваться одновременно с object_id, attribute_name и odata_filter.

user_type

строка

Строковое значение для классификации типов пользователей в каталоге, например «Участник» и «Гость».

Используется при создании или обновлении учетной записи пользователя.

x509_certificate_path

путь

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат должен быть добавлен после закрытого ключа.

Используется для аутентификации с помощью субъекта-службы.

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

Содержит атрибуты extensionAttributes1–15 пользователя.

Эти атрибуты расширения также называются пользовательскими атрибутами Exchange 1–15.

Для пользователя с включенной синхронизацией с локальной средой (onPremisesSyncEnabled) источником достоверных данных для этого набора свойств является локальная среда; свойства доступны только для чтения.

Для облачного пользователя (у которого onPremisesSyncEnabled имеет значение false) эти свойства можно задать при создании или обновлении объекта пользователя.

Для облачного пользователя, ранее синхронизированного из локальной Active Directory, эти свойства доступны только для чтения в Microsoft Graph, но ими можно полностью управлять через Центр администрирования Exchange или модуль Exchange Online V2 для PowerShell.

Возвращается: всегда

Пример: {}

user_principal_name

string

Имя участника-пользователя.

Возвращается: всегда

Пример: "jsmith@contoso.com"

user_type

string

Строковое значение, которое можно использовать для классификации типов пользователей в каталоге.

Возвращается: всегда

Пример: "Member"