Модуль azure.azcollection.azure_rm_roleassignment — Управление назначением ролей Azure

Примечание

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

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

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

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

Новая в 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 added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. Default: `"latest"`
assignee_object_id aliases: assignee string	Идентификатор объекта получателя. Это соответствует ID внутри Active Directory. Он может указывать на пользователя, субъект безопасности или группу безопасности. Обязательно при создании назначения роли.
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. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
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`. Варианты: `false` ← (по умолчанию) `true`
id string	Полностью квалифицированный идентификатор назначения для удаления или создания. Взаимоисключающе с scope и name
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string	Уникальное имя назначения роли. Имя назначения роли должно быть GUID, пример: «3ce0cbb0-58c4-4e6d-a16d-99d86a78b3ca». Взаимоисключающе с id
password string	Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.

role_definition_id string	Идентификатор определения роли, используемый в назначении роли. Требуется при создании назначения роли.
scope string	Область применения назначения роли для создания. Например, для подписки используйте /subscriptions/{subscription-id}/. /subscriptions/{subscription-id}/resourceGroups/{resource-group-name} для группы ресурсов. /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name} для ресурса. Взаимоисключающее с id
secret string	Секрет клиента Azure. Используется при аутентификации с помощью Служебного принципала.
state string	Утверждение состояния назначения роли. Используйте `present` для создания или обновления назначения роли и `absent` для его удаления. Если `present`, тогда role_definition_id и assignee_object_id оба требуются Варианты: `"absent"` `"present"` ← (по умолчанию)
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: Create a role assignment
  azure_rm_roleassignment:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    assignee_object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    role_definition_id:
      "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

- name: Create a role assignment
  azure_rm_roleassignment:
    name: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    assignee_object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    role_definition_id:
      "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

- name: Delete a role assignment
  azure_rm_roleassignment:
    name: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    state: absent

- name: Delete a role assignment
  azure_rm_roleassignment:
    id: /subscriptions/xxx-sub-guid-xxx/resourceGroups/rgname/providers/Microsoft.Authorization/roleAssignments/xxx-assign-guid-xxx"
    state: absent

- name: Delete a role assignment
  azure_rm_roleassignment:
    scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    assignee_object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    role_definition_id:
      "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    state: absent

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

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

Ключ	Описание
assignee_object_id строка	Идентификатор субъекта, которому назначена роль. Возвращается: всегда Пример: `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
id строка	Идентификатор текущего назначения роли. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
name строка	Имя назначения роли. Возвращается: всегда Пример: `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
principal_type строка	Тип субъекта, которому назначена роль. Возвращается: всегда Пример: `"ServicePrincipal"`
role_definition_id строка	Идентификатор определения роли, назначенной субъекту principal_id. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
scope строка	Область применения назначения роли. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
type строка	Тип назначения роли. Возвращается: всегда Пример: `"Microsoft.Authorization/roleAssignments"`

Авторы

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_module.html