Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_roleassignment_info – Получение фактов о назначении ролей Azure

Примечание

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

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_roleassignment_info.

Добавлена в azure.azcollection 0.1.2

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

Обзор

  • Получение фактов о назначении ролей Azure.

Требования

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

  • 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"

assignee

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

строка

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

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

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"
END_OF_DOCUMENT_MARKER

role_definition_id

string

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

scope

string

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

Например, используйте /subscriptions/{идентификатор-подписки}/ для подписки.

/subscriptions/{идентификатор-подписки}/resourceGroups/{имя-группы-ресурсов} для группы ресурсов.

/subscriptions/{идентификатор-подписки}/resourceGroups/{имя-группы-ресурсов}/providers/{имя-поставщика-ресурсов}/{тип-ресурса}/{имя-ресурса} для ресурса.

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

secret

string

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

strict_scope_match

boolean

Если strict_scope_match равен True, назначения ролей будут возвращаться только для точно заданной области.

Унаследованные назначения ролей будут исключены из результатов.

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

Варианты:

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

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, или выполнить вход перед запуском задач или 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 CLI

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

Примеры

- name: Get role assignments for specific service principal
  azure_rm_roleassignment_info:
    assignee: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments for specific scope that matches specific role definition
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    role_definition_id: /subscriptions/xxx-sub-guid-xxx/providers/Microsoft.Authorization/roleDefinitions/xxx-role-guid-xxxx

- name: Get role assignments for specific scope with no inherited assignments
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    strict_scope_match: true

- name: Get role assignments by name
  azure_rm_roleassignment_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    name: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get role assignments by id
  azure_rm_roleassignment_info:
    id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
END_OF_DOCUMENT_MARKER

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

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

Ключ

Описание

roleassignments

сложный

Список назначений ролей.

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

id

строка

Идентификатор назначения роли.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

name

строка

Название назначения роли.

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

Пример: "myRoleAssignment"

principal_id

строка

Идентификатор принципала, которому назначена роль.

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

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

principal_type

строка

Тип принципала, которому назначена роль.

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

Пример: "ServicePrincipal"

role_definition_id

строка

Идентификатор определения роли, назначенного principal_id.

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

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

scope

строка

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

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

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

type

строка

Тип назначения роли.

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

Пример: "custom"

Авторы

  • Yunge Zhu(@yungezz)
  • 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_roleassignment_info_module.html

Spec-Zone.ru

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