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

Примечание

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

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

Для использования в книге задач укажите: 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` могут использоваться для идентификации идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az 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, или войти в систему перед запуском задач или книги задач с помощью 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 сложный				всегда	Список словарей результатов, где ключ — имя RegistrationDefinition, а значения — факты для этой RegistrationDefinition.
	id строка			всегда	Полный путь к определению регистрации.
	name строка			всегда	Имя определения регистрации.
	plan сложный			всегда	Подробности плана для управляемых служб.
		name строка		всегда	Название плана.
		product строка		всегда	Код продукта.
		publisher строка		всегда	Идентификатор издателя.
		version строка		всегда	Версия плана.
	properties сложный			всегда	Свойства определения регистрации.
		authorizations сложный		всегда	Кортеж авторизации, содержащий идентификатор принципала пользователя/группы безопасности или принципала службы и идентификатор встроенной роли.
			principal_id строка	всегда	Идентификатор принципала группы безопасности/принципала службы/пользователя, которому будут назначены разрешения на проектную подписку.
			role_definition_id строка	всегда	Идентификатор определения роли. Роль определяет все разрешения, которые должны иметь группа безопасности/принципал службы/пользователь на подписке. Роль не может быть ролью владельца.
		description строка		всегда	Описание определения регистрации.
		managed_by_tenant_id строка		всегда	Идентификатор управляющего клиента.
		registration_definition_name строка		всегда	Имя определения регистрации.
	type строка			всегда	Тип ресурса.

Авторы

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