azure_rm_publicipaddress - Управление общедоступными IP-адресами Azure.
Новая версия 2.1.
Обзор
- Создание, обновление и удаление общедоступного IP-адреса. Позволяет устанавливать и обновлять метод распределения адресов и метку доменного имени. Используйте модуль azure_rm_networkinterface для ассоциации общедоступного IP-адреса с сетевым интерфейсом.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным принципом службы. |
| allocation_method |
| Управление тем, остается ли назначенный общедоступный IP-адрес постоянно назначенным объекту. Если не установлено 'Static', IP-адрес может быть изменен в любой момент при циклической перезагрузке связанной виртуальной машины. |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags | Значение по умолчанию: yes | Управление тем, является ли поле тегов каноническим или только добавляет к существующим тегам. При каноническом значении теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source (добавлено в 2.5) |
| Управление источником учетных данных для аутентификации. auto будет следовать умолчанию порядка параметров модуля -> переменных окружения -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.При установке cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть установлен через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлено в 2.5) |
None | Управление поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или при подключении к Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | ID клиента Azure. Используйте при аутентификации с главным принципом службы. |
| cloud_environment (добавлено в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес точки конечного доступа обнаружения метаданных (необходим для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. |
| domain_name_label | Значение по умолчанию: None | Настраиваемая часть FQDN, назначенная общедоступному IP-адресу. Это явное значение. Если значение не указано, любое существующее значение будет удалено у существующего общедоступного IP-адреса. псевдонимы: domain_name_label |
| location | Значение по умолчанию: местоположение группы ресурсов | Допустимое местоположение Azure. По умолчанию соответствует местоположению группы ресурсов. |
| name требуется | Имя общедоступного IP-адреса. | |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным принципом службы. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group требуется | Имя группы ресурсов, к которой относится общедоступный IP-адрес. | |
| secret | Значение по умолчанию: None | Секретный ключ клиента Azure. Используйте при аутентификации с главным принципом службы. |
| state |
| Утверждение состояния общедоступного IP-адреса. Используйте 'present' для создания или обновления и 'absent' для удаления. |
| subscription_id | Значение по умолчанию: None | Ваш идентификатор подписки Azure. |
| tags | Значение по умолчанию: None | Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. |
| tenant | Значение по умолчанию: None | Идентификатор клиента 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 dict | всегда | Данные о текущем состоянии объекта. Пример: {'dns_settings': {}, 'name': 'publicip002', 'tags': {}, 'public_ip_allocation_method': 'Static', 'provisioning_state': 'Succeeded', 'ip_address': '52.160.103.93', 'etag': '"/"a5e56955-12df-445a-bda4-dc129d22c12f"', 'location': 'westus', 'idle_timeout_in_minutes': 4, 'type': 'Microsoft.Network/publicIPAddresses'} |
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- 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.5/modules/azure_rm_publicipaddress_module.html
