azure.azcollection.azure_rm_registrationdefinition_info – Получение информации о RegistrationDefinition

Примечание

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

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

Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_registrationdefinition_info.

Новый в версии 1.3.0: из azure.azcollection

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

Обзор

Получить информацию о 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 вместо службы-принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
registration_definition_id строка		Идентификатор определения регистрации.
scope строка		Идентификатор подписки определяет подписку, в которой будет получено определение регистрации. Если не указано, используется подписка, полученная из AzureRMAuth.
secret строка		Секретный ключ клиента Azure. Используется при аутентификации с помощью службы-принципала.
subscription_id строка		Ваш идентификатор Azure-подписки.
tags словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные тегов объекта будут обновлены с предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с помощью службы-принципала.

Примечания

Примечание

Для аутентификации с 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: Get Registration Definition
  azure_rm_registrationdefinition_info:
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Get All Registration Definitions from AzureRMAuth's subscription
  azure_rm_registrationdefinition_info:

- name: Get All Registration Definitions in the subscription levle
  azure_rm_registrationdefinition_info:
      scope: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

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

Ключ				Возвращаемое значение	Описание
registration_definitions complex				всегда	Список словарей результатов, где ключ — имя RegistrationDefinition, а значения — факты для этой RegistrationDefinition.
	id string			всегда	Полный путь к определению регистрации.
	name string			всегда	Имя определения регистрации.
	plan complex			всегда	Подробности плана для управляемых служб.
		name string		всегда	Имя плана.
		product string		всегда	Код продукта.
		publisher string		всегда	Идентификатор издателя.
		version string		всегда	Версия плана.
	properties complex			всегда	Свойства определения регистрации.
		authorizations complex		всегда	Кортеж авторизации, содержащий идентификатор принципала пользователя/группы безопасности или принципала службы и идентификатор встроенной роли.
			principal_id string	всегда	Идентификатор принципала группы безопасности/принципала службы/пользователя, которому будут назначены разрешения на спроецированную подписку.
			role_definition_id string	всегда	Идентификатор определения роли. Роль определяет все разрешения, которые должна иметь группа безопасности/принципал службы/пользователь на подписку. Роль не может быть ролью владельца.
		description string		всегда	Описание определения регистрации.
		managed_by_tenant_id string		всегда	Идентификатор управляемого арендатора.
		registration_definition_name string		всегда	Имя определения регистрации.
	type string			всегда	Тип ресурса.

Авторы

Fred-Sun (@Fred-Sun)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_registrationdefinition_info_module.html