azure.azcollection.azure_rm_apimanagement_info модуль — Получение информации об экземпляре API
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_apimanagement_info.
Новая функция в azure.azcollection 1.6.0
Обзор
- Получение информации об экземпляре API.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, выполняющем этот модуль.
- 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_id string | Идентификатор ревизии API. Он должен быть уникальным в текущем экземпляре службы API Management. |
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:
|
expand_api_version_set boolean | Включить полный ресурс ApiVersionSet в ответ Choices:
|
include_not_tagged_apis boolean | Включить не помеченные API в ответ. Choices:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
пароль строка | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. |
профиль строка | Профиль безопасности, найденный в файле ~/.azure/credentials. |
группа_ресурсов строка / обязательно | Название группы ресурсов. |
секрет строка | Секрет Azure-клиента. Используется при аутентификации с помощью службы-принципала. |
имя_службы строка / обязательно | Название службы API Management. |
id_подписки строка | Ваш идентификатор подписки Azure. |
метки словарь | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Для удаления меток установите параметр append_tags в false. В настоящее время в зонах Azure DNS и службах Traffic Manager также не разрешено использовать пробелы в метке. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 меток на ресурсах. |
арендатор строка | Идентификатор арендатора 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход в систему с помощью Azure CLI
-
Как войти в систему с помощью команды
az login.
Примеры
- name: Get the information of api
azure_rm_apimanagement_info:
resource_group: myResourceGroup
service_name: myService
- name: Get the information of api
azure_rm_apimanagement_info:
resource_group: myResourceGroup
service_name: myService
api_id: testApi
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
api сложный | Список результатов словарей, где ключ — имя Api, а значения — факты для этого Api. Возвращается: всегда |
|
имя_api сложный |
Имя api, предоставленное пользователем. Возвращается: успех |
|
id строка |
Идентификатор ресурса. Возвращается: всегда |
|
имя строка |
Имя ресурса. Возвращается: всегда |
|
свойства словарь |
Свойства контракта сущности Api. Возвращается: всегда |
|
тип строка |
Тип ресурса для ресурса API Management. Возвращается: всегда |
Ссылки на сборку
© 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_apimanagement_info_module.html