azure_rm_publicipaddress – Управление общедоступными IP-адресами Azure

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

Обзор

Создание, обновление и удаление общедоступного IP-адреса.
Позволяет установить и обновить метод выделения адреса и метку доменного имени.
Используйте модуль azure_rm_networkinterface для ассоциации общедоступного IP-адреса с сетевым интерфейсом.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user строка			Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в 2.6			URL-адрес службы авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой авторизации ADFS.
allocation_method -		Варианты: dynamic ← static Static Dynamic	Управление тем, остается ли назначенный общедоступный IP-адрес постоянно назначенным объекту. Если не установлено значение `Static`, IP-адрес может измениться в любой момент при циклическом включении/выключении виртуальной машины.
api_profile строка добавлено в 2.5		По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логическое		Варианты: no yes ←	Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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 строка			ID клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлено в 2.4		По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки доступа к метаданным (требуется для Azure Stack). Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
domain_name -			Настраиваемая часть FQDN, назначенная общедоступному IP-адресу. Это явное значение. Если значение не указано, любое существующее значение будет удалено для существующего общедоступного IP-адреса. псевдонимы: domain_name_label
idle_timeout целое число добавлено в 2.8			Таймаут бездействия в минутах.
ip_tags - добавлено в 2.8			Список тегов IpTag, связанных с общедоступным IP-адресом. Каждый элемент должен содержать пару тип:значение.
	type -		Устанавливает тип ip_tags.
	value -		Устанавливает значение ip_tags.
location -			Действительное расположение Azure. По умолчанию используется расположение группы ресурсов.
name - / обязательно			Имя общедоступного IP-адреса.
password строка			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно			Имя группы ресурсов, к которой связан общедоступный IP-адрес.
secret строка			Секретный ключ клиента Azure. Используйте при аутентификации с принципалом службы.
sku - добавлено в 2.6		Варианты: basic standard Basic Standard	SKU общедоступного IP-адреса.
state -		Варианты: absent present ←	Утверждение состояния общедоступного IP-адреса. Используйте `present` для создания или обновления и `absent` для удаления.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка для присвоения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в false.
tenant строка			Идентификатор арендатора Azure. Используйте при аутентификации с принципалом службы.
version - добавлено в 2.8		Варианты: ipv4 ← ipv6	Версия общедоступного IP-адреса.

Примечания

Примечание

Для аутентификации с 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: Create a public ip address
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    allocation_method: static
    domain_name: foobar

- name: Delete public ip
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    state: absent

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

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

Ключ		Возвращаемое значение	Описание
state сложный		всегда	Факты о текущем состоянии объекта.
	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'
	idle_timeout_in_minutes целое число	всегда	Таймаут бездействия общедоступного IP-адреса. Пример: 4
	ip_address строка	всегда	Префикс общедоступного IP-адреса, который должен быть выделен этому общедоступному IP-адресу. Пример: 52.160.103.93
	location строка	всегда	Расположение ресурса.
	name строка	всегда	Имя общедоступного IP-адреса.
	provisioning_state строка	всегда	Состояние подготовки общедоступного IP-ресурса.
	public_ip_address_version строка	всегда	Версия общедоступного IP-адреса. Пример: ipv4
	public_ip_allocation_method строка	всегда	Метод выделения общедоступного IP-адреса. Пример: static
	sku строка	всегда	SKU общедоступного IP-адреса. Пример: Basic
	tags словарь	всегда	Теги ресурса. Пример: {'delete': 'on-exit', 'testing': 'testing'}
	type строка	всегда	Тип ресурса. Пример: Microsoft.Network/publicIPAddresses

Статус

Для этого модуля не гарантируется обратная совместимость интерфейса. [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_module.html