Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_managementgroup_info – Получение фактов о группе управления Azure

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_managementgroup_info.

Новый в azure.azcollection 1.5.0

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

Описание

  • Получение фактов о конкретной группе управления или всех группах управления.

Требования

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

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

Параметры

Параметр

Комментарии

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"

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"

name

aliases: management_group_name

строка

Ограничить результаты конкретной управляющей группой по имени.

Взаимоисключающее с id.

password

строка

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

profile

строка

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

recurse

логическое

По умолчанию (False), если children равно (True), возвращаются только непосредственные дочерние элементы.

Если (True), возвращаются все потомки иерархии.

Параметр имеет значение только при children равном (True), в противном случае он будет проигнорирован.

Варианты:

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

secret

строка

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

subscription_id

строка

Ваш идентификатор подписки Azure.

tenant

строка

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

thumbprint

строка

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

Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path.

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

Требуется, если определено x509_certificate_path.

x509_certificate_path

путь

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

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

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

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

Примечания

Примечание

  • azure_rm_managementgroup_info - Роли, назначенные принципалу, выполняющему playbook, определяют, что является корневой управляющей группой. Возможно также запросить сведения о родительской управляющей группе, но невозможно получить эту группу. Сильно рекомендуется, если children установлено (True), запрашивать конкретные управляющие группы, так как список всех групп потребует дополнительный вызов API Azure для каждой возвращенной группы.
  • Для аутентификации в Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти перед выполнением задач или playbook с 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_rm_subscription_info

модуль для получения более подробной информации о подписках; например, теги.

azure_rm_roleassignment_info

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

Вход в Azure CLI

Как войти с помощью команды az login.

Примеры

- name: Get facts for all root management groups for authenticated principal
  azure_rm_managementgroup_info:

- name: Get facts for one management group by id with direct children
  azure_rm_managementgroup_info:
    id: /providers/Microsoft.Management/managementGroups/contoso-group
    children: true

- name: Get facts for one management group by name with all children, flattened into top list
  azure_rm_managementgroup_info:
    name: "contoso-group"
    children: true
    recurse: true
    flatten: true

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

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

Ключ

Описание

management_groups

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

Список словарей Групп управления.

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

children

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

Вложенные группы управления или подписки.

Возвращается: если children равно c(True)

Пример: ["Nested list of children. Same as top groups", " but without tenant_id."]

display_name

строка

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

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

Пример: "My Management Group"

id

строка

Полный идентификатор группы управления.

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

Пример: "/providers/Microsoft.Management/managementGroups/group-name"

name

строка

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

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

Пример: "group-name"

tenant_id

строка

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

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

Пример: "00000000-0000-0000-0000-000000000000"

type

строка

Тип группы управления.

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

Пример: "/providers/Microsoft.Management/managementGroups"

subscriptions

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

Список объектов подписок.

Возвращается: если children и flatten оба равны c(True)

display_name

строка

Имя отображения подписки.

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

Пример: "some-subscription-name"

id

строка

Полный идентификатор подписки.

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

Пример: "/subscriptions/00000000-0000-0000-0000-feedc0ffee000000"

subscription_id

строка

Идентификатор подписки в формате GUID.

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

Пример: "00000000-0000-0000-0000-feedc0ffee000000"

type

строка

Тип группы управления.

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

Пример: "/subscriptions"

Авторы

  • Paul Aiton (@paultaiton)

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

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

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

Spec-Zone.ru

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