azure.azcollection.azure_rm_registrationdefinition – Управление экземпляром Azure RegistrationDefinition

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

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

В версии 1.3.0: коллекции azure.azcollection

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

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
ad_user строка				Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала.
adfs_authority_url строка добавлено в 0.0.1 коллекции azure.azcollection				URL-адрес источника Azure AD. Используется при аутентификации с именем пользователя/паролем и собственном источнике ADFS.
api_profile строка добавлено в 0.0.1 коллекции azure.azcollection			По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логическое			Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или добавляется к существующим тегам. При каноническом варианте теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 коллекции azure.azcollection			Варианты: авто ← cli credential_file env msi	Управление источником учетных данных для аутентификации. Также может быть задано через переменную окружения `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.
cert_validation_mode строка добавлено в 0.0.1 коллекции azure.azcollection			Варианты: ignore validate	Управление поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или подключении к Azure Stack, возможно, потребуется отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка				Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
cloud_environment строка добавлено в 0.0.1 коллекции azure.azcollection			По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки доступа к метаданным (необходим для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
password строка				Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
plan словарь				Подробности плана для управляемых служб.
	name строка / обязательно			Имя плана.
	product строка / обязательно			Код продукта.
	publisher строка / обязательно			Идентификатор издателя.
	version строка / обязательно			Версия плана.
profile строка				Профиль безопасности, находящийся в файле ~/.azure/credentials.
properties словарь				Свойства определения регистрации.
	authorizations список / элементы=строка / обязательно			Кортеж авторизации, содержащий идентификатор принципала пользователя/группы безопасности или сервисного принципала и идентификатор встроенной роли.
		principal_id строка / обязательно		Идентификатор принципала группы безопасности/сервисного принципала/пользователя, которому будут назначены разрешения на целевую подписку.
		role_definition_id строка / обязательно		Идентификатор определения роли. Эта роль определит все разрешения, которые должна иметь группа безопасности/сервисный принципал/пользователь на целевой подписке. Эта роль не может быть ролью владельца.
	description строка			Описание определения регистрации.
	managed_by_tenant_id строка / обязательно			Идентификатор управляемого арендатора.
	registration_definition_name строка			Имя определения регистрации.
registration_definition_id строка				Идентификатор определения регистрации. Если не указан, для него будет сгенерирован UUID.
scope строка				Идентификатор подписки определяет подписку, в которой будет создано определение регистрации. Если не указан, используется подписка, полученная из AzureRMAuth.
secret строка				Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала.
state строка			Варианты: absent present ←	Утверждение состояния RegistrationDefinition. Используйте `present` для создания или обновления RegistrationDefinition и `absent` для удаления.
subscription_id строка				Ваш идентификатор подписки Azure.
tags словарь				Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant строка				Идентификатор арендатора Azure. Используется при аутентификации с помощью сервисного принципала.

Примечания

Примечание

Для аутентификации с 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. Также возможно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_registrationdefinition_module.html