Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_privateendpoint_info – Получение информации о частных конечных точках

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.

Для использования в playbook, укажите: azure.azcollection.azure_rm_privateendpoint_info.

Новая функция в azure.azcollection 1.8.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, или войти в систему перед запуском задач или 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. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в переменных окружения.

См. также

См. также

Вход в Azure CLI

Как войти в систему с помощью команды az login.

Примеры

- name: Get facts for one private endpoint
  azure_rm_privateendpoint_info:
    resource_group: myResourceGroup
    name: testprivateendpoint

- name: Get all private endpoint under the resource group
  azure_rm_privateendpoint_info:
    resource_group: myResourceGroup

- name: Get all private endpoint under subscription
  azure_rm_virtualnetwork_info:
    tags:
      - key1:value1

Возвращаемые значения

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ

Описание

state

сложный

Список словарей частного конечного пункта с тем же форматом, что и параметр модуля azure.azcollection.azure_rm_privateendpoint.

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

etag

строка

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

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

Пример: "W/\"20803842-7d51-46b2-a790-ded8971b4d8a"

id

строка

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

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

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

location

строка

Действительное расположение Azure.

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

Пример: "eastus"

name

строка

Имя частного конечного пункта.

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

Пример: "estprivateendpoint"

network_interfaces

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

Список идентификаторов сетевых интерфейсов.

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

Пример: ["/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/fredprivateendpoint002.nic"]

private_link_service_connections

сложный

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

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

connection_state

сложный

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

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

actions_required

строка

Сообщение, указывающее, требуются ли какие-либо обновления у потребителя, связанные с изменениями на стороне поставщика услуг.

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

Пример: "This is action_required string"

description

строка

Причина одобрения/отклонения подключения.

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

Пример: "Auto Approved"

status

строка

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

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

Пример: "Approved"

group_ids

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

Список group_ids, связанных с частным конечным пунктом.

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

Пример: ["postgresqlServer"]

id

строка

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

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

name

строка

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

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

provisioning_state

строка

Состояние подготовки ресурса.

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

Пример: "Succeeded"

subnets_id

строка

Подсети, связанные с виртуальной сетью.

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

Пример: "/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/fredtestRG-vnet/subnets/default"

tags

словарь

Теги, назначенные ресурсу. Словарь пар строка:строка.

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

Пример: {"tag1": "abc"}

Тип

строка

Тип ресурса.

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

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

Авторы

  • 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_privateendpoint_info_module.html

Spec-Zone.ru

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