Модуль azure.azcollection.azure_rm_privatelinkservice_info – Получение информации о подключении к частной конечной точке
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_privatelinkservice_info.
Новое в azure.azcollection 1.12.0
Описание
- Получение данных о подключении к частной конечной точке.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором будет выполняться этот модуль.
- 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: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
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**, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя частной службы связи. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string | Имя группы ресурсов. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
метки список / элементы=строка | Ограничить результаты, предоставив список меток. Формат меток — «ключ» или «ключ:значение». |
арендатор строка | Идентификатор аренды Azure. Используется при аутентификации с помощью Служебного принципа. |
отпечаток_ключа строка добавлено в azure.azcollection 1.14.0 | Отпечаток цифрового сертификата закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципа. Требуется, если определен x509_certificate_path. |
путь_к_сертификату_x509 путь добавлено в azure.azcollection 1.14.0 | Путь к X509-сертификату, используемому для создания служебного принципа в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью Служебного принципа. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, задать переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед выполнением задач или книги команд с
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 private link service info by name
azure_rm_privatelinkservice_info:
name: pn-service-name
resource_group: myResourceGroup
- name: Get all private link service by resource group
azure_rm_privatelinkservice_info:
resource_group: myResourceGroup
- name: Get all private link service by subscription filter by tags
azure_rm_privatelinkservice_info:
tags:
- key1
- abc
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
link_service complex | Список информации о частной службе соединения. Возвращается: всегда |
|
alias string |
Псевдоним частной службы соединения. Возвращается: всегда Пример: |
|
auto_approval dictionary |
Список автоматического утверждения частной службы соединения. Возвращается: всегда Пример: |
|
enable_proxy_protocol boolean |
Включена ли для частной службы соединения поддержка протокола прокси или нет Возвращается: всегда Пример: |
|
etag string |
Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: |
|
fqdns list / elements=string |
Список Fqdn. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса частной службы соединения. Возвращается: всегда Пример: |
|
ip_configurations complex |
Массив конфигураций IP-адресов частной службы соединения. Возвращается: всегда |
|
name string |
Имя конфигураций IP-адресов. Возвращается: всегда Пример: |
|
properties complex |
Свойства конфигурации IP-адресов. Возвращается: всегда |
|
primary boolean |
Является ли конфигурация IP-адреса основной или нет. Возвращается: всегда Пример: |
|
private_ip_address_version string |
Указывает, является ли конкретная конфигурация IP-адреса IPv4 или IPv6. Возвращается: всегда Пример: |
|
private_ip_allocation_method string |
Метод выделения частного IP-адреса. Возвращается: всегда Пример: |
|
subnet dictionary |
Ссылка на ресурс подсети. Возвращается: всегда Пример: |
|
load_balancer_frontend_ip_configurations list / elements=string |
Массив ссылок на конфигурации IP-адресов подсистемы балансировки нагрузки. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя частной службы соединения. Возвращается: всегда Пример: |
|
network_interfaces список / элементы=строка |
Массив ссылок на сетевые интерфейсы, созданные для данной службы частной связи. Возвращается: всегда Пример: |
|
private_endpoint_connections сложный тип |
Массив списков подключений к частному конечному пункту. Возвращается: всегда |
|
id строка |
Идентификатор подключения к частному конечному пункту. Возвращается: всегда Пример: |
|
private_endpoint строка |
Идентификатор частного конечного пункта. Возвращается: всегда Пример: |
|
provisioning_state строка |
Состояние подготовки ресурса службы частной связи. Возвращается: всегда Пример: |
|
tags словарь |
Теги ресурса. Возвращается: всегда Пример: |
|
type строка |
Тип ресурса. Возвращается: всегда Пример: |
|
visibility словарь |
Список видимости службы частной связи. Возвращается: всегда Пример: |
Ссылки на сборку
© 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_privatelinkservice_info_module.html