Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_adgroup_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_adgroup_info.

Новая в azure.azcollection 1.6.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, не вернет пользователей.

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

Choices:

  • false ← (default)
  • true

api_profile

string

added in azure.azcollection 0.0.1

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

Default: "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

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.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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

Choices:

  • "ignore"
  • "validate"

check_membership

string

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

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.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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

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

Choices:

  • false ← (default)
  • true

log_mode

string

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

log_path

string

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

object_id

string

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

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

odata_filter

string

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

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.

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

Используется при аутентификации с сервисным принципалом.

Примечания

Примечание

  • Для аутентификации с 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

См. также

Вход с помощью Azure CLI

Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Return a specific group using object_id
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Return a specific group using object_id and  return the owners of the group
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_owners: true

- name: Return a specific group using object_id and return the owners and members of the group
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_owners: true
    return_group_members: true
- name: Return a specific group using object_id and return the owners and members of the group. Return service principals and nested groups.
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_owners: true
    return_group_members: true
    raw_membership: true

- name: Return a specific group using object_id and return the groups the group is a member of
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_member_groups: true

- name: Return a specific group using object_id and check an ID for membership
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    check_membership: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Return a specific group using displayName for attribute_name
  azure_rm_adgroup_info:
    attribute_name: "displayName"
    attribute_value: "Display-Name-Of-AD-Group"

- name: Return groups matching odata_filter
  azure_rm_adgroup_info:
    odata_filter: "mailNickname eq 'Mail-Nickname-Of-AD-Group'"

- name: Return all groups
  azure_rm_adgroup_info:
    all: true

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

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

Ключ

Описание

description

строка

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

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

Пример: "fortest"

display_name

строка

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

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

Пример: "GroupName"

group_members

список / элементы=строка

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

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

group_owners

список / элементы=строка

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

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

mail

строка

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

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

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

mail_enabled

логическое

Включена ли электронная почта для группы. Должно быть false. Это связано с тем, что только чистые группы безопасности могут быть созданы с помощью API графа.

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

Пример: false

mail_nickname

строка

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

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

Пример: "groupname"

object_id

строка

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

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

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

security_enabled

логическое

Включена ли безопасность для группы.

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

Пример: false

Авторы

  • Cole Neubauer(@coleneubauer)
  • Xu Zhang(@xuzhang)

Ссылки на коллекцию

  • Трекер задач
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API