Модуль azure.azcollection.azure_rm_apimanagementservice_info – Получение информации о ApiManagementService

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_apimanagementservice_info.

Новая функция в azure.azcollection 1.5.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Получение информации о ApiManagementService.

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.

python >= 2.7
На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, выполняющем модули из azure.azcollection.
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в azure.azcollection 0.0.1	URL-адрес службы авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой авторизации ADFS.
api_profile строка добавлен в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
auth_source строка добавлен в 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"`

thumbprint string added in azure.azcollection 1.14.0	Отпечаток пальца закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Требуется, если определен параметр x509_certificate_path.
x509_certificate_path path added in 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 Api Management Service By Name and Resource Group
  azure_rm_apimanagementservice_info:
    resource_group: myResourceGroup
    name: myApiName

- name: Get Api Management Service By Resource Group
  azure_rm_apimanagementservice_info:
    resource_group: myResourceGroup

- name: Get Api Management Service By Subscription
  azure_rm_apimanagementservice_info:

Значения возврата

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

Ключ	Описание
api_management_service complex	Список результатов словарей, где ключ — имя ApiManagementService. Значения — факты для этого ApiManagementService. Возвращаемое значение: всегда
etag string	ETag ресурса. Возвращаемое значение: всегда Пример: `"AAAAAAAsQK8="`
id string	Идентификатор ресурса. Возвращаемое значение: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/myPolicy"`
identity string	Идентификатор ресурса. Возвращаемое значение: всегда
location string	Расположение ресурса. Возвращаемое значение: всегда Пример: `"East US"`
name string	Имя ресурса. Возвращаемое значение: всегда Пример: `"myPolicy"`
properties dictionary	Свойства службы API Management. Возвращаемое значение: всегда
sku string	Свойства SKU службы API Management. Возвращаемое значение: всегда Пример: `"Developer"`
tags dictionary	Теги ресурса. Возвращаемое значение: всегда Пример: `{"key1": "value1"}`
type string	Тип ресурса для ресурса API Management задан как Microsoft.ApiManagement. Возвращаемое значение: всегда Пример: `"Microsoft.ApiManagement/service"`
zones string	Зона ресурса. Возвращаемое значение: всегда

Авторы

Nikhil Patne (@nikhilpatne)
Sakar Mehra (@Sakar97)

Ссылки на коллекцию

© 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_apimanagementservice_info_module.html