azure_rm_publicipaddress_facts – Получение фактов о публичных IP-адресах
Новая версия 2.1.
Синопсис
- Получение фактов о конкретном публичном IP-адресе или всех публичных IP-адресах в группе ресурсов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. | |
| adfs_authority_url строка добавлено в 2.6 | URL-адрес службы авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой авторизации ADFS. | |
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбор профиля API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| 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. |
| name - | Показать только результаты для определенного публичного IP-адреса. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - | Ограничить результаты по группе ресурсов. Требуется при использовании параметра name. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags - | Ограничить результаты, указав список тегов. Формат тегов: 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с помощью службы-принципала. |
Примечания
Примечание
- Для аутентификации с 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: Get facts for one Public IP
azure_rm_publicipaddress_facts:
resource_group: myResourceGroup
name: publicip001
- name: Get facts for all Public IPs within a resource groups
azure_rm_publicipaddress_facts:
resource_group: myResourceGroup
Значения возврата
Общие значения возврата описаны в разделе здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| azure_publicipaddresses список | всегда | Список словарей с общедоступными IP-адресами. Обратите внимание, что этот параметр будет устаревшим в версии 2.10, когда структурированный формат станет единственным поддерживаемым. | |
| publicipaddresses сложный тип | всегда | Список общедоступных IP-адресов Содержит детали, соответствующие параметрам azure_rm_publicipaddress. Возвращается, когда параметр формата установлен в структурированный. | |
| allocation_method строка | всегда | Метод выделения общедоступного IP-адреса. Возможные значения: 'static' и 'dynamic'. | |
| dns_settings сложный тип | всегда | FQDN записи DNS, связанной с общедоступным IP-адресом. | |
| etag строка | всегда | Уникальная неизменяемая строка, которая изменяется всякий раз, когда ресурс обновляется. | |
| id строка | всегда | Идентификатор ресурса. | |
| idle_timeout целое число | всегда | Таймаут бездействия общедоступного IP-адреса. | |
| ip_address строка | всегда | Префикс общедоступного IP, из которого должен быть выделен этот общедоступный IP-адрес. | |
| ip_tags сложный тип | всегда | Список тегов, связанных с общедоступным IP-адресом. | |
| location строка | всегда | Расположение ресурса. | |
| name строка | всегда | Имя общедоступного IP-адреса. | |
| provisioning_state строка | всегда | Состояние подготовки ресурса PublicIP. Возможные значения: 'Updating', 'Deleting' и 'Failed'. | |
| sku строка | всегда | SKU общедоступного IP-адреса. | |
| tags сложный тип | всегда | Теги ресурса. | |
| type строка | всегда | Тип ресурса. | |
| version строка | всегда | Версия общедоступного IP-адреса. Возможные значения: 'ipv4' и 'ipv6'. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_facts_module.html
