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

Примечание

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

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

Для использования в playbook, укажите: azure.azcollection.azure_rm_publicipaddress.

Новое в версии 0.1.0: of azure.azcollection

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

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

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

Примечания

Примечание

Для аутентификации с 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: 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

Авторы

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

При парсинге документации для этого плагина были обнаружены некоторые ошибки. Пожалуйста, отправьте отчет об ошибке в коллекцию.

Ошибки:

Unable to normalize azure_rm_publicipaddress: return due to: 11 validation errors for PluginReturnSchema
return -> state -> contains -> dns_settings -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> etag -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> idle_timeout_in_minutes -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> ip_address -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> location -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> name -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> provisioning_state -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> public_ip_address_version -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> public_ip_allocation_method -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> tags -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> type -> returns
  extra fields not permitted (type=value_error.extra)

© 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_publicipaddress_module.html