Модуль azure.azcollection.azure_rm_apimanagement — Управление экземплярами Azure API

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_apimanagement.

Добавлена в azure.azcollection 1.6.0

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

Описание

Создание экземпляра Azure API.
Обновление существующего экземпляра Azure API.
Удаление экземпляра Azure API.

Требования

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

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

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS.
api_id строка / обязательно	Идентификатор ревизии API. Он должен быть уникальным в текущем экземпляре службы API Management.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
api_revision строка	Описывает ревизию API. Если значение не указано, создается ревизия по умолчанию 1.
api_revision_description строка	Описание ревизии API.
api_type строка	Тип создаваемого API. `http` создает API SOAP-REST. `soap` создает проходящий SOAP-API. Варианты: `"soap"` `"http"`
api_version строка	Указывает идентификатор версии API, если API имеет версии.
api_version_description строка	Описание версии API.
api_version_set словарь	Подробности набора версий.
description строка	Описание набора версий API.
id строка	Идентификатор существующего набора версий API. Опустите это значение для создания нового набора версий.
name строка	Имя набора версий API для отображения.
version_header_name строка	Имя параметра HTTP-заголовка, который указывает версию API, если versioningScheme задано как `header`.
version_query_name строка	Имя параметра запроса, который указывает версию API, если versioningScheme задано как `query`.
versioning_scheme строка	Значение, определяющее, где будет находиться идентификатор версии API в HTTP-запросе. Варианты: `"Segment"` `"Query"` `"Header"`
api_version_set_id строка	Идентификатор ресурса связанного ApiVersionSet.
append_tags логическое	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
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"`

authentication_settings словарь	Набор параметров аутентификации, включённых в этот API.
o_auth2 словарь	Параметры аутентификации OAuth2
authorization_server_id строка	Идентификатор сервера авторизации OAuth.
scope строка	Область операций.
openid словарь	Настройки аутентификации OpenID Connect
bearer_token_sending_methods список / элементы=строка	Способ отправки токена на сервер. Выбор: `"authorizationHeader"` `"query"`
openid_provider_id строка	Идентификатор сервера авторизации OAuth.
cert_validation_mode строка добавлено в azure.azcollection 0.0.1	Управляет поведением проверки сертификата для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано в файле профилей учетных данных или в переменной среды `AZURE_CERT_VALIDATION`. Выбор: `"ignore"` `"validate"`
client_id строка	Идентификатор Azure клиента. Используется при аутентификации с помощью Служебного принципала или Управляемой идентификации (msi). Также может быть задано в переменной среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Может быть задан в файле профилей учетных данных или в переменной среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
description строка	Описание API.
disable_instance_discovery булево добавлено в azure.azcollection 2.3.0	Определяет, будет ли выполнено обнаружение экземпляра при попытке аутентификации. Установка этого значения в true полностью отключит обнаружение экземпляра и проверку полномочий. Эта функция предназначена для использования в сценариях, где не удается получить доступ к точке входа метаданных, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров предполагает получение метаданных полномочий с https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. Поэтому крайне важно убедиться, что хост настроенных полномочий действителен и надежен. Настройка в файле профилей учетных данных или в переменной среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Выбор: `false` ← (по умолчанию) `true`
display_name строка	Имя API для отображения. Оно должно быть длиной от 1 до 300 символов.
format строка	Формат содержимого, в котором импортируется API. Выбор: `"wadl-xml"` `"wadl-link-json"` `"swagger-json"` `"swagger-link-json"` `"wsdl"` `"wsdl-link"` `"openapi"` `"openapi+json"` `"openapi-link"`
is_current булево	Указывает, является ли текущая версия API текущей версией. Выбор: `false` `true`
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
password строка	Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
path строка	Относительный URL, уникально идентифицирующий этот API.
profile строка	Профиль безопасности, найденный в файле ~/.azure/credentials.

protocols список / элементы=строка	Описывает протоколы, по которым можно вызывать операции в этом API. Варианты: `"http"` `"https"`
resource_group строка / обязательно	Имя группы ресурсов.
secret строка	Секретный ключ Azure. Используется при аутентификации с помощью Служебного принципала.
service_name строка / обязательно	Имя службы API Management.
service_url строка	Абсолютный URL-адрес службы бэкенда, реализующей этот API Длина не должна превышать 2000 символов.
source_api_id строка	Идентификатор API исходного API.
state строка	Состояние API. Используйте `present` для создания или обновления API и `absent` для его удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Ваш идентификатор подписки Azure.
subscription_key_parameter_names словарь	Протоколы, по которым доступен API.
header строка	Имя заголовка ключа подписки.
query строка	Имя параметра строки запроса ключа подписки.
subscription_required логическое значение	Указывает, требуется ли подписка API или продукта для доступа к API. Варианты: `false` `true`
tags словарь	Словарь пар "строка:строка" для присвоения метаданных объекту. Метаданные теги объекта будут обновлены предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.
tenant строка	Идентификатор аренды Azure. Используется при аутентификации с помощью Служебного принципала.
thumbprint строка добавлен в azure.azcollection 1.14.0	Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципала. Требуется, если определен x509_certificate_path.
type строка	Тип API Варианты: `"http"` `"soap"`
value строка	Значение содержимого при импорте API.
wsdl_selector словарь	Критерии для ограничения импорта WSDL подмножеством документа.
wsdl_endpoint_name строка	Имя конечной точки (порта) для импорта из WSDL.
wsdl_service_name строка	Имя службы для импорта из WSDL.
x509_certificate_path путь добавлен в 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: Create a new API instance
  azure_rm_apimanagement:
    resource_group: 'myResourceGroup'
    service_name: myService
    api_id: testApi
    description: testDescription
    display_name: TestAPI
    service_url: 'http://testapi.example.net/api'
    path: myapiPath
    protocols:
      - https
- name: Update an existing API instance.
  azure_rm_apimanagement:
    resource_group: myResourceGroup
    service_name: myService
    api_id: testApi
    display_name: newTestAPI
    service_url: 'http://testapi.example.net/api'
    path: myapiPath
    protocols:
      - https
- name: ApiManagementDeleteApi
  azure_rm_apimanagement:
    resource_group: myResourceGroup
    service_name: myService
    api_id: testApi
    state: absent

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

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

Ключ	Описание
id string	Идентификатор ресурса. Возвращается: всегда

Авторы

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

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

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