ApiCenterProductionVersionPlugin

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

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

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

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

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

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

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

Никакой

Замечания

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

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

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

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

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

{
  "apiCenterProductionVersionPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenterproductionversionplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME"
  }
}

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

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