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

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

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

Описание

Создание, обновление и удаление общедоступного 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 -		Варианты: динамический ← статический Статический Динамический	Управление тем, остается ли назначенный общедоступный IP-адрес постоянно назначенным объекту. Если не установлено «Статический», IP-адрес может измениться при любом перезапуске виртуальной машины, связанной с ним.
api_profile строка добавлено в 2.5		По умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure services. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логический тип		Варианты: нет да ←	Используйте для управления тем, является ли поле тегов стандартным или просто добавляет к существующим тегам. При использовании в качестве стандартного, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5		Варианты: авто 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`.
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 -		Варианты: отсутствует присутствует ←	Утверждает состояние общедоступного 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': {}, 'etag': '"/"a5e56955-12df-445a-bda4-dc129d22c12f"', 'idle_timeout_in_minutes': 4, 'ip_address': '52.160.103.93', 'location': 'westus', 'name': 'publicip002', 'provisioning_state': 'Succeeded', 'public_ip_allocation_method': 'static', 'tags': {}, 'type': 'Microsoft.Network/publicIPAddresses'}

Статус

Интерфейс этого модуля не гарантирует обратную совместимость. [бета-версия]
Этот модуль поддерживается сообществом 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.8/modules/azure_rm_publicipaddress_module.html