Модуль azure.azcollection.azure_rm_vpnsite_info – Получение информации о VpnSite
Примечание
Этот модуль входит в состав коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_vpnsite_info.
Новое в azure.azcollection 1.5.0
Описание
- Получение информации о VpnSite.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, где выполняется данный модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлено через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Choices:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлено через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате важно убедиться, что настроенный узел узла действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя извлекаемого VpnSite. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string | Имя группы ресурсов VpnSite. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
tags dictionary | Словарь пар "строка:строка", которые будут назначены в качестве метаданных к объекту. Метаданные объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах. |
tenant string | Идентификатор Azure-тенанта. Используется при аутентификации с помощью принципала службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Требуется, если определен x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к X509-сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью принципала службы. |
Примечания
Примечание
- Для аутентификации с 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход с помощью Azure CLI
-
Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: Get Vpn Site Info by name
azure_rm_vpnsite_info:
resource_group: myResourceGroup
name: vwan_site_name
- name: Get Vpn Site List By ResourceGroup
azure_rm_vpnsite_info:
resource_group: myResourceGroup
- name: Get Vpn Site List By Subscription
azure_rm_vpnsite_info:
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
vpn_sites complex | Список результатов в формате словаря, где ключ — имя VpnSite, а значения — данные для этого VpnSite. Возвращается: всегда |
|
address_space dictionary |
AddressSpace, содержащий массив диапазонов IP-адресов. Возвращается: всегда Пример: |
|
device_properties dictionary |
Свойства устройства. Возвращается: всегда Пример: |
|
etag string |
Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
is_security_site boolean |
Флаг IsSecuritySite. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя ресурса. Возвращается: всегда Пример: |
|
o365_policy dictionary |
Политика Office365. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки ресурса VPN-сайта. Возвращается: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: всегда Пример: |
|
type string |
Тип ресурса. Возвращается: всегда Пример: |
|
virtual_wan dictionary |
VirtualWAN, к которому принадлежит vpnSite. Возвращается: всегда Пример: |
|
vpn_site_links complex |
Список всех ссылок на VPN-сайты. Возвращается: всегда |
|
etag string |
Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
ip_address string |
IP-адрес для vpn-site-link. Возвращается: всегда Пример: |
|
link_properties dictionary |
Свойства поставщика ссылки. Возвращается: всегда Пример: |
|
Имя строка |
Имя ресурса, уникальное в рамках группы ресурсов. Это имя может быть использовано для доступа к ресурсу. Возвращается: всегда Пример: |
|
Тип строка |
Тип ресурса. Возвращается: всегда Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_vpnsite_info_module.html