ApiCenterOnboardingPlugin

Статья
05/25/2024

Проверяет, зарегистрированы ли API, используемые в приложении, в указанном экземпляре Центра API Azure.

Определение экземпляра подключаемого модуля

{
  "name": "ApiCenterOnboardingPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "apiCenterOnboardingPlugin"
}

Пример конфигурации

{
  "apiCenterOnboardingPlugin": {
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default",
    "createApicEntryForNewApis": true
  }
}

Свойства конфигурации

Свойство	Описание	По умолчанию
`createApicEntryForNewApis`	Задайте значение , `true` чтобы прокси-сервер разработчика создавал новые записи API для обнаруженных API, которые еще не зарегистрированы в Центре API. Если задано значение `false` Dev Proxy, в командной строке отображаются только незарегистрированные API.	`true`
`resourceGroupName`	Имя группы ресурсов, в которой находится Центр API Azure.	None
`serviceName`	Имя экземпляра Центра API Azure, который должен использовать прокси-сервер разработки для проверка, зарегистрированы ли API- интерфейсы, используемые в приложении.	None
`subscriptionId`	Идентификатор подписки Azure, в которой находится экземпляр Центра API Azure.	None
`workspace`	Имя используемой рабочей области Центра API Azure.	`default`

Параметры командной строки

None

Remarks

Подключаемый ApiCenterOnboardingPlugin модуль проверяет, зарегистрированы ли API, используемые в приложении, в указанном экземпляре Центра API Azure. Если API-интерфейсы не зарегистрированы, подключаемый модуль может создавать записи API в экземпляре Центра API.

Для подключения к Центру API Azure подключаемый модуль использует учетные данные Azure (в следующем порядке):

Среда
Удостоверение рабочей нагрузки
Управляемое удостоверение
Visual Studio
Visual Studio Code
Azure CLI
Azure PowerShell
Azure Developer CLI

Если подключаемого модуля не удается получить маркер доступа для доступа к Azure, отображается сообщение об ошибке, а прокси-сервер разработки отключает его. Войдите в Azure с помощью любого из этих средств и перезапустите прокси-сервер разработки, чтобы использовать подключаемый ApiCenterOnboardingPlugin модуль.

При использовании прокси-сервера разработки в конвейерах CI/CD можно передать значения свойств subscriptionId, resourceGroupName, serviceNameи workspaceName в качестве переменных среды. Чтобы использовать переменные среды, добавьте к имени значения @, например:

{
  "apiCenterOnboardingPlugin": {
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME",
    "createApicEntryForNewApis": true
  }
}

В этом примере подключаемый ApiCenterOnboardingPlugin модуль задает subscriptionIdсвойства , resourceGroupName, serviceNameи workspaceName значения переменных AZURE_SUBSCRIPTION_IDсреды , AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEи AZURE_APIC_WORKSPACE_NAME соответственно.

Поделиться через