azure_rm_publicipaddress_info – Получение данных о публичном IP-адресе

Новая версия 2.9.

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

Обзор

Получение данных о конкретном публичном IP-адресе или всех публичных IP-адресах в группе ресурсов.

Псевдонимы: azure_rm_publicipaddress_facts

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью служебного принципала.
adfs_authority_url строка добавлен в 2.6		URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS.
api_profile строка добавлен в 2.5	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлен в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать стандартной приоритетности модульных параметров -> переменных среды -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или подключения к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала.
cloud_environment строка добавлен в 2.4	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
name -		Отображать результаты только для конкретного публичного IP-адреса.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group -		Ограничение результатов по группе ресурсов. Требуется при использовании параметра name.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
subscription_id строка		Идентификатор вашей подписки Azure.
tags -		Ограничение результатов с помощью списка тегов. Формат тегов 'ключ' или 'ключ:значение'.
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 facts for one Public IP
  azure_rm_publicipaddress_info:
    resource_group: myResourceGroup
    name: publicip001

- name: Get facts for all Public IPs within a resource groups
  azure_rm_publicipaddress_info:
    resource_group: myResourceGroup

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

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

Ключ		Возвращаемое значение	Описание
azure_publicipaddresses список		всегда	Список словарей с адресами общедоступных IP-адресов. Обратите внимание, что этот параметр будет устаревшим в версии 2.10, когда структурированный формат станет единственным поддерживаемым форматом.
publicipaddresses сложный		всегда	Список общедоступных IP-адресов. Содержит подробности, соответствующие параметрам azure_rm_publicipaddress. Возвращается, когда параметр format установлен в curated.
	allocation_method строка	всегда	Метод выделения общедоступного IP-адреса. Возможные значения: `static` и `dynamic`. Пример: static
	dns_settings словарь	всегда	FQDN записи DNS, связанной с общедоступным IP-адресом. Пример: {'domain_name_label': 'ansible-b57dc95985712e45eb8b9c2e', 'fqdn': 'ansible-b57dc95985712e45eb8b9c2e.eastus.cloudapp.azure.com', 'reverse_fqdn': None}
	etag строка	всегда	Уникальная неизменяемая строка, которая изменяется при каждом обновлении ресурса. Пример: W/'1905ee13-7623-45b1-bc6b-4a12b2fb9d15'
	id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxx---xxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/publicIPAddresses/pipb57dc95224
	idle_timeout целое число	всегда	Таймаут бездействия общедоступного IP-адреса. Пример: 4
	ip_address строка	всегда	Префикс общедоступного IP, из которого следует выделять общедоступный IP-адрес. Пример: 40.121.144.14
	ip_tags список	всегда	Список тегов, связанных с общедоступным IP-адресом. Пример: [{'type': 'FirstPartyUsage', 'value': 'Storage'}]
	location строка	всегда	Расположение ресурса. Пример: eastus
	name строка	всегда	Имя общедоступного IP-адреса. Пример: pipb57dc95224
	provisioning_state строка	всегда	Состояние подготовки ресурса PublicIP. Возможные значения: `Succeeded`. Пример: Succeeded
	sku строка	всегда	SKU общедоступного IP-адреса. Пример: Basic
	tags словарь	всегда	Теги ресурса. Пример: {'delete': 'on-exit', 'testing': 'testing'}
	type строка	всегда	Тип ресурса. Пример: Microsoft.Network/publicIPAddresses
	version строка	всегда	Версия общедоступного IP-адреса. Возможные значения: `ipv4` и `ipv6`. Пример: ipv4

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
Данный модуль поддерживается сообществом Ansible. [community]

Авторы

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_publicipaddress_info_module.html