модуль azure.azcollection.azure_rm_roleassignment_info — получение сведений о назначениях ролей Azure
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 string | Имя пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю с собственным центром ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для обмена данными со службами Azure. Значение по умолчанию По умолчанию: |
assignee псевдонимы: assignee_object_id string | Идентификатор объекта пользователя, группы или субъекта-службы. Не может использоваться одновременно с name и id. |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной окружения Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной окружения |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка значения true полностью отключает обнаружение экземпляра и проверку центра. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с https://login.microsoft.com/ для проверки центра. Установив значение **True**, вы отключаете проверку центра. Поэтому крайне важно убедиться, что настроенный узел центра является действительным и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной окружения Варианты:
|
id string | Полный идентификатор назначений ролей для поиска. Если задано, role_definition_id и scope будут без предупреждения проигнорированы. Не может использоваться одновременно с assignee и name. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя назначения роли. Требуется также задать scope. Не может использоваться одновременно с assignee и id. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной окружения |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ часто используется на платформах, которые предоставляют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения |
password string | Пароль пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
role_definition_id string | Идентификатор ресурса определения роли. |
scope string | Область, в которой нужно искать назначения ролей. Например, для подписки используйте /subscriptions/{subscription-id}/. Для группы ресурсов используйте /subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name}. Для ресурса используйте /subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name}/providers/{resource-provider}/{resource-type}/{resource-name}. По умолчанию возвращаются все унаследованные назначения из родительских областей; см. strict_scope_match. |
secret string | Секрет клиента Azure. Используется для аутентификации с помощью субъекта-службы. |
strict_scope_match boolean | Если strict_scope_match имеет значение 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 или войти в систему перед запуском задач или плейбука с помощью
az login. - Также можно выполнить аутентификацию с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации с помощью субъекта-службы передайте 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
roleassignments complex | Список назначений ролей. Возвращается: всегда |
|
id string |
Идентификатор назначения роли. Возвращается: всегда Пример: |
|
name string |
Имя назначения роли. Возвращается: всегда Пример: |
|
principal_id string |
Идентификатор субъекта, которому назначена роль. Возвращается: всегда Пример: |
|
principal_type string |
Тип субъекта, которому назначена роль. Возвращается: всегда Пример: |
|
role_definition_id string |
Идентификатор определения роли, назначенной principal_id. Возвращается: всегда Пример: |
|
scope string |
Область назначения роли. Возвращается: всегда Пример: |
|
type string |
Тип назначения роли. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_roleassignment_info_module.html