модуль azure.azcollection.azure_rm_adgroup_info — получение сведений о группе Azure Active Directory

ad_user

string

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

adfs_authority_url

string

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

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

all

boolean

Если значение равно True, будут возвращены все группы в клиенте.

Если значение равно False, пользователи не будут возвращены.

Рекомендуется вместо этого указать подмножество групп и использовать фильтр.

Варианты:

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

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.

attribute_value

string

Значение, с которым нужно сопоставить attribute_name.

Если attribute_name не является коллекцией, будут возвращены группы, в которых attribute_name равен attribute_value.

Если attribute_name является коллекцией, будут возвращены группы пользователей, в которых attribute_value входит в attribute_name.

auth_source

string

добавлено в 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

string

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

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

Варианты:

• "ignore"
• "validate"

check_membership

string

Идентификатор объекта контакта, группы, пользователя или субъекта-службы, членство которого проверяется в возвращенных группах.

client_id

string

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

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

cloud_environment

string

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

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

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

disable_instance_discovery

boolean

добавлено в 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

Идентификатор объекта группы AD.

Возвращает группу с этим идентификатором объекта.

odata_filter

string

Возвращает группы в соответствии с фильтром OData, переданным этому параметру.

oidc_token

string

добавлено в 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

path

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

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

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

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

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

password

string

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

profile

string

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

raw_membership

boolean

По умолчанию возвращаемое свойство group_members преобразуется в плоскую структуру, а объекты, не являющиеся пользователями, частично фильтруются. Этот аргумент отключает такие преобразования.

Варианты:

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

return_group_members

boolean

Указывает, следует ли возвращать участников группы вместе с возвращаемыми группами.

Варианты:

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

return_member_groups

boolean

Указывает, следует ли возвращать группы, участником которых является группа, вместе с возвращаемыми группами.

Варианты:

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

return_owners

boolean

Указывает, следует ли возвращать владельцев группы вместе с возвращаемыми группами.

Варианты:

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

secret

string

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

subscription_id

string

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

tenant

string

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

thumbprint

string

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

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

Используйте при аутентификации с субъектом-службой.

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

x509_certificate_path

path

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

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

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

Используйте при аутентификации с субъектом-службой.

description

string

Необязательное описание группы.

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

Пример: "fortest"

display_name

string

Отображаемое имя группы.

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

Пример: "GroupName"

group_members

list / elements=string

Участники группы. Если задан параметр raw_membership, это поле может содержать объекты, не являющиеся пользователями (группы, субъекты-службы и т. д.).

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

group_owners

list / elements=string

Владельцы группы.

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

mail

string

Основной адрес электронной почты группы.

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

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

mail_enabled

boolean

Указывает, поддерживает ли группа электронную почту. Значение должно быть false, поскольку с помощью Graph API можно создавать только группы безопасности без дополнительных возможностей.

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

Пример: false

mail_nickname

string

Почтовый псевдоним группы.

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

Пример: "groupname"

object_id

string

Идентификатор object_id группы.

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

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

security_enabled

boolean

Указывает, является ли группа группой безопасности.

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

Пример: false