Spec-Zone.ru › Ansible 2.9

azure_rm_roledefinition_info – Получение фактов о определении роли Azure

Новая версия с 2.9.

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

Описание

  • Получение фактов об определении роли Azure.

Псевдонимы: azure_rm_roledefinition_facts

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не сервисного принципала.
adfs_authority_url
строка
добавлен в 2.6
URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственного авторитета ADFS.
api_profile
строка
добавлен в 2.5
Значение по умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source
строка
добавлен в 2.5
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию будет установлено значение auto если переменная не определена.
auto будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.
При установке cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.
Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При установке msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка.
msi был добавлен в Ansible 2.6.
cert_validation_mode
строка
добавлен в 2.5
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификата для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано в файле учетных данных или через переменную среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
cloud_environment
строка
добавлен в 2.4
Значение по умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано в файле учетных данных или через переменную среды AZURE_CLOUD_ENVIRONMENT.
id
-
Идентификатор определения роли.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не сервисного принципала.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
role_name
-
Название роли.
scope
- / обязательно
Область определения роли.
secret
строка
Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала.
subscription_id
строка
Идентификатор вашей подписки Azure.
tenant
строка
Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
type
-
    Варианты:
  • system
  • custom
Тип роли.

Примечания

Примечание

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

См. также

См. также

Вход с помощью Azure CLI
Как войти в систему с помощью команды az login.

Примеры

- name: List Role Definitions in scope
  azure_rm_roledefinition_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup

- name: Get Role Definition by name
  azure_rm_roledefinition_info:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup
    name: myRoleDefinition

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
roledefinitions
complex
всегда
Список фактов определения ролей.

assignable_scopes
list
всегда
Список назначаемых областей действия этого определения.

Пример:
['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup']
id
string
всегда
Идентификатор определения роли.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
name
string
всегда
Назначаемое системой имя роли.

Пример:
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
permissions
-
всегда
Список разрешений определения роли.

actions
list
всегда
Список разрешенных действий.

Пример:
['Microsoft.Compute/virtualMachines/read']
data_actions
list
всегда
Список разрешенных действий с данными.

Пример:
['Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read']
not_actions
list
всегда
Список запрещенных действий.

Пример:
['Microsoft.Compute/virtualMachines/write']
not_data_actions
list
всегда
Список запрещенных действий с данными.

Пример:
['Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write']
role_name
string
всегда
Имя роли.

Пример:
myCustomRoleDefinition


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Yunge Zhu(@yungezz)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_roledefinition_info_module.html

Spec-Zone.ru

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