модуль azure.azcollection.azure_rm_privatelinkservice_info – получение сведений о подключении частной конечной точки
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | ID клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению Azure Python SDK, например, По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта функция предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия. Задается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя службы Private Link. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), непосредственно используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается на токен Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только исходный токен. Этот метод обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string | Имя группы ресурсов. |
secret string | Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
subscription_id string | ID вашей подписки Azure. |
tags list / элементы=string | Ограничьте результаты, указав список тегов. Формат тегов: «ключ» или «ключ:значение». |
tenant string | ID клиента 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 или выполнить вход перед запуском задач или плейбука с помощью
az login. - Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации с помощью субъекта-службы передайте 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 | Список сведений о службе Private Link. Возвращается: всегда |
|
alias string |
Псевдоним службы Private Link. Возвращается: всегда Пример: |
|
auto_approval dictionary |
Список автоматического одобрения службы Private Link. Возвращается: всегда Пример: |
|
enable_proxy_protocol boolean |
Включена ли для службы Private Link поддержка протокола proxy. Возвращается: всегда Пример: |
|
etag string |
Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: |
|
fqdns list / elements=string |
Список полных доменных имен (FQDN). Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса службы Private Link. Возвращается: всегда Пример: |
|
ip_configurations complex |
Массив конфигураций IP-адресов службы Private Link. Возвращается: всегда |
|
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 |
Имя службы Private Link. Возвращается: всегда Пример: |
|
network_interfaces list / elements=string |
Массив ссылок на сетевые интерфейсы, созданные для этой службы Private Link. Возвращается: всегда Пример: |
|
private_endpoint_connections complex |
Массив сведений о подключениях к частной конечной точке. Возвращается: всегда |
|
id string |
Идентификатор подключения частной конечной точки. Возвращается: всегда Пример: |
|
private_endpoint string |
Идентификатор частной конечной точки. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки ресурса службы Private Link. Возвращается: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: всегда Пример: |
|
type string |
Тип ресурса. Возвращается: всегда Пример: |
|
visibility dictionary |
Список видимости службы Private Link. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_privatelinkservice_info_module.html