ApiCenterOnboardingPlugin

2025-04-30

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

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

{
  "name": "ApiCenterOnboardingPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "apiCenterOnboardingPlugin"
}

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

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default",
    "createApicEntryForNewApis": true
  }
}

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

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

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

Никакой

Замечания

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

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

Окружающая среда
Удостоверение рабочей нагрузки
Управляемое удостоверение
Визуальная студия
Visual Studio Code
Azure CLI (Интерфейс командной строки для Azure)
Azure PowerShell
Интерфейс командной строки разработчика Azure

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

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

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "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 переменных среды соответственно.

Следующий шаг

Поиск теневых API