ApiCenterOnboardingPlugin

项目
05/25/2024

检查应用中使用的 API 是否已在指定的 Azure API 中心实例中注册。

插件实例定义

{
  "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` “开发代理”时，仅在命令提示符中列出未注册的 API。	`true`
`resourceGroupName`	Azure API 中心所在的资源组的名称。	无
`serviceName`	如果注册了应用中使用的 API，则开发代理应用于检查的 Azure API 中心实例的名称。	无
`subscriptionId`	Azure API 中心实例所在的 Azure 订阅的 ID。	无
`workspace`	要使用的 Azure API 中心工作区的名称。	`default`

命令行选项

无

备注

该 ApiCenterOnboardingPlugin 插件检查应用中使用的 API 是否已在指定的 Azure API 中心实例中注册。如果未注册 API，插件可以在 API 中心实例中创建新的 API 条目。

为了连接到 Azure API 中心，该插件使用 Azure 凭据 (按以下顺序) ：

环境
工作负载标识
托管标识
Visual Studio
Visual Studio Code
Azure CLI
Azure PowerShell
Azure 开发人员 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插件将、resourceGroupName、 serviceName和 workspaceName 属性分别设置为 subscriptionId、AZURE_RESOURCE_GROUP_NAME、 AZURE_APIC_INSTANCE_NAME和 AZURE_APIC_WORKSPACE_NAME 环境变量的值AZURE_SUBSCRIPTION_ID。

通过

ApiCenterOnboardingPlugin

插件实例定义

配置示例

配置属性

命令行选项

备注

其他资源