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) | По умолчанию: null | URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS. |
| allocation_method |
| Управление тем, остается ли назначенный общедоступный IP-адрес постоянно привязан к объекту. Если не установлено значение 'Статический', IP-адрес может быть изменен в любой момент при перезагрузке виртуальной машины. |
| api_profile (добавлено в 2.5) | По умолчанию: "latest" | Выбор профиля API для использования при общении с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags bool |
| Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source (добавлено в 2.5) |
| Управление источником учетных данных для аутентификации. Если не указано, будет использоваться переменная окружения 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) |
| Управление поведением проверки сертификатов для 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) |
| SKU общедоступного IP-адреса. |
| state |
| Утверждение состояния общедоступного 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 dict | всегда | Данные о текущем состоянии объекта. Пример: {'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. Подробнее см. Поддержка и обслуживание модулей.
Список других модулей, поддерживаемых партнёром Ansible, см. здесь.
Автор
- Крис Хауснект (@chouseknecht)
- Мэтт Дэвис (@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.6/modules/azure_rm_publicipaddress_module.html
