azure_rm_publicipaddress_facts - Получение фактов о публичных IP-адресах.
Новое в версии 2.1.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Получение фактов для определенного публичного IP-адреса или всех публичных IP-адресов в группе ресурсов.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| ad_user | нет | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | ||
| client_id | нет | Идентификатор клиента Azure. Используйте при аутентификации с сервисным принципалом. | ||
| cloud_environment | нет | 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. Используйте при аутентификации с сервисным принципалом. |
Примеры
- name: Get facts for one Public IP
azure_rm_publicip_facts:
resource_group: Testing
name: publicip001
- name: Get facts for all Public IPs within a resource groups
azure_rm_publicip_facts:
resource_group: Testing
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| azure_publicipaddresses | Список словарей публичных IP-адресов. | всегда | список |
Примечания
Примечание
- Для аутентификации с 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 в среде.
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратной совместимости интерфейса.
Для получения помощи в разработке модулей, если вы заинтересованы в этом, пожалуйста, прочитайте Справочная информация по сообществу и внесению вклада, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_publicipaddress_facts_module.html
