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

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

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

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user -		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url - добавлено в 2.6	По умолчанию: null	URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственном авторитете ADFS.
allocation_method -	Варианты: Dynamic ← Static	Управление тем, остается ли назначенный общедоступный IP-адрес постоянно назначенным объекту. Если не установлено значение 'Static', IP-адрес может быть изменён в любое время при перезагрузке виртуальной машины.
api_profile - добавлено в 2.5	По умолчанию: "latest"	Выбирает профиль API для использования при общении с сервисами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags boolean	Варианты: 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	Варианты: validate ignore	Управляет поведением проверки сертификатов для конечных точек 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
location -		Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
name - / обязательно		Имя общедоступного IP-адреса.
password -		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile -		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно		Имя группы ресурсов, к которой связан общедоступный IP-адрес.
secret -		Секретный ключ клиента Azure. Используйте при аутентификации с принципалом службы.
sku - добавлено в 2.6	Варианты: Basic Standard	SKU общедоступного IP-адреса.
state -	Варианты: absent present ←	Утверждение состояния общедоступного IP-адреса. Используйте 'present' для создания или обновления, и 'absent' для удаления.
subscription_id -		Идентификатор вашей подписки Azure.
tags -		Словарь пар строка:строка для назначения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant -		Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, сохранённый в ~/.azure/credentials. Аутентификация возможна с помощью принципала службы или пользователя 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 в среде.

Примеры

- name: Create a public ip address
  azure_rm_publicipaddress:
    resource_group: testing
    name: my_public_ip
    allocation_method: Static
    domain_name: foobar

- name: Delete public ip
  azure_rm_publicipaddress:
    resource_group: testing
    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. [сертифицировано]

Авторы

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.7/modules/azure_rm_publicipaddress_module.html