Spec-Zone.ru › Ansible

Модуль 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. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Также может быть установлен через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.

При установке в auto (по умолчанию) приоритет имеет параметры модуля -> env -> credential_file -> cli.

При установке в env, учетные данные будут считываться из переменных среды

При установке в credential_file, он будет считывать профиль из ~/.azure/credentials.

При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть установлен через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • 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

Псевдоним частной службы соединения.

Возвращается: всегда

Пример: "linkservice.6a244dd8-8416-40cf-8c04-52b353bdd507.eastus.azure.privatelinkservice"

auto_approval

dictionary

Список автоматического утверждения частной службы соединения.

Возвращается: всегда

Пример: {"subscriptions": []}

enable_proxy_protocol

boolean

Включена ли для частной службы соединения поддержка протокола прокси или нет

Возвращается: всегда

Пример: false

etag

string

Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса.

Возвращается: всегда

Пример: "f7d60f37-ea2b-4091-8546-1327f35468c4"

fqdns

list / elements=string

Список Fqdn.

Возвращается: всегда

Пример: ["fqdns1.com", "fqdns2.com"]

id

string

Идентификатор ресурса частной службы соединения.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateLinkServices/linkservice"

ip_configurations

complex

Массив конфигураций IP-адресов частной службы соединения.

Возвращается: всегда

name

string

Имя конфигураций IP-адресов.

Возвращается: всегда

Пример: "subnetfredprivate-1"

properties

complex

Свойства конфигурации IP-адресов.

Возвращается: всегда

primary

boolean

Является ли конфигурация IP-адреса основной или нет.

Возвращается: всегда

Пример: true

private_ip_address_version

string

Указывает, является ли конкретная конфигурация IP-адреса IPv4 или IPv6.

Возвращается: всегда

Пример: "IPv4"

private_ip_allocation_method

string

Метод выделения частного IP-адреса.

Возвращается: всегда

Пример: "Dynamic"

subnet

dictionary

Ссылка на ресурс подсети.

Возвращается: всегда

Пример: {"id": "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subname"}

load_balancer_frontend_ip_configurations

list / elements=string

Массив ссылок на конфигурации IP-адресов подсистемы балансировки нагрузки.

Возвращается: всегда

Пример: [{"id": "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/loadBalancers/testlb/frontendIPConfigurations/front01"}]

location

string

Расположение ресурса.

Возвращается: всегда

Пример: "eastus"

name

string

Имя частной службы соединения.

Возвращается: всегда

Пример: "linkservice"

network_interfaces

список / элементы=строка

Массив ссылок на сетевые интерфейсы, созданные для данной службы частной связи.

Возвращается: всегда

Пример: [{"id": "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/testlinkservice.nic.f5"}]

private_endpoint_connections

сложный тип

Массив списков подключений к частному конечному пункту.

Возвращается: всегда

id

строка

Идентификатор подключения к частному конечному пункту.

Возвращается: всегда

Пример: "/subscriptions/xxx/resourceGroups/myReG/providers/Microsoft.Network/privateLinkServices/linkservice/privateEndpointConnections/tes"

private_endpoint

строка

Идентификатор частного конечного пункта.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/test002"

provisioning_state

строка

Состояние подготовки ресурса службы частной связи.

Возвращается: всегда

Пример: "Succeeded"

tags

словарь

Теги ресурса.

Возвращается: всегда

Пример: {"key1": "value1"}

type

строка

Тип ресурса.

Возвращается: всегда

Пример: "Microsoft.Network/privateLinkServices"

visibility

словарь

Список видимости службы частной связи.

Возвращается: всегда

Пример: {"subscriptions": []}

Авторы

  • xuzhang3 (@xuzhang3)
  • Fred-sun (@Fred-sun)

Ссылки на сборку

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (исходные коды)

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API