Модуль azure.azcollection.azure_rm_registrationdefinition — Управление экземпляром Azure RegistrationDefinition

Примечание

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

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

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

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

Новая в azure.azcollection 1.3.0

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

Описание

Создание, обновление и удаление экземпляра Azure RegistrationDefinition.

Требования

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

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"`
append_tags boolean	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices: `false` `true` ← (default)
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. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав `ignore`. Может быть также установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Choices: `"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`. Choices: `false` ← (default) `true`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.
plan dictionary	Подробная информация о плане для управляемых служб.
name string / required	Название плана.
product string / required	Код продукта.

исполнитель строка / обязательно	Идентификатор издателя.
версия строка / обязательно	Версия плана.
профиль строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
свойства словарь	Свойства определения регистрации.
разрешения список / элементы=словарь / обязательно	Кортеж авторизации, содержащий идентификатор принципала пользователя/группы безопасности или службы и идентификатор встроенной роли.
principal_id строка / обязательно	Идентификатор принципала группы безопасности/службы/пользователя, которому будут предоставлены разрешения на спроецированную подписку.
role_definition_id строка / обязательно	Идентификатор определения роли. Эта роль определит все разрешения, которые должна иметь группа безопасности/служба/пользователь на спроецированной подписке. Эта роль не может быть ролью владельца.
описание строка	Описание определения регистрации.
managed_by_tenant_id строка / обязательно	Идентификатор управляемого клиента.
имя_определения_регистрации строка	Имя определения регистрации.
id_определения_регистрации строка	Идентификатор определения регистрации. Если не указано, будет сгенерирован UUID.
область строка	Идентификатор подписки определяет подписку, в которой будет создано определение регистрации. Если не указано, будет использована подписка, полученная из AzureRMAuth.
секрет строка	Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
состояние строка	Утвердите состояние RegistrationDefinition. Используйте `present` для создания или обновления RegistrationDefinition и `absent` для её удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
id_подписки строка	Ваш идентификатор подписки Azure.
метки словарь	Словарь пар «строка:строка» для присвоения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в метке. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 меток на ресурсах.
клиент строка	Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы.
отпечаток строка добавлено в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Требуется, если определён x509_certificate_path.
x509_certificate_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 Registration Definition without scope
  azure_rm_registrationdefinition:
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    properties:
      description: test
      authorizations:
        - principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      registration_definition_name: def4

- name: Create Registration Definition with scope
  azure_rm_registrationdefinition:
    scope: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    properties:
      description: test
      authorizations:
        - principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      registration_definition_name: def5

- name: Delete Registration Definition
  azure_rm_registrationdefinition:
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    state: absent

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

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

Ключ	Описание
state complex	Информация о состоянии привязки регистрации. Возвращается: всегда
id string	Полный путь к определению регистрации. Возвращается: всегда
name string	Имя определения регистрации. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
plan complex	Подробности плана для управляемых служб. Возвращается: всегда
name string	Имя плана. Возвращается: всегда
product string	Код продукта. Возвращается: всегда
publisher string	Идентификатор издателя. Возвращается: всегда
version string	Версия плана. Возвращается: всегда
properties complex	Свойства определения регистрации. Возвращается: всегда
authorizations complex	Кортеж авторизации, содержащий идентификатор принципала пользователя/группы безопасности или служебного принципала и идентификатор встроенной роли. Возвращается: всегда
principal_id string	Идентификатор принципала группы безопасности/служебного принципала/пользователя, которому будут назначены разрешения на подписку Возвращается: всегда Пример: `"99e3227f-8701-4099-869f-bc3efc7f1e64"`
role_definition_id string	Идентификатор определения роли. Эта роль определит все разрешения, которые должна иметь группа безопасности/служебный принцип/пользователь в подписке. Эта роль не может быть ролью владельца. Возвращается: всегда Пример: `"b24988ac-6180-42a0-ab88-20f7382dd24c"`
description string	Описание определения регистрации. Возвращается: всегда Пример: `"test"`
managed_by_tenant_id string	Идентификатор управляемого клиента. Возвращается: всегда
registration_definition_name string	Имя определения регистрации. Возвращается: всегда
type string	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.ManagedServices/registrationDefinitions"`

Авторы

Fred-Sun (@Fred-Sun)

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

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