ApiCenterOnboardingPlugin

發行項
05/25/2024

檢查應用程式中使用的 API 是否已在指定的 Azure API 中心實例中註冊。

外掛程式實例定義

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

設定範例

{
  "apiCenterOnboardingPlugin": {
    "subscriptionId": "cdae2297-7aa6-4195-bbb1-dcd89153cc72",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default",
    "createApicEntryForNewApis": true
  }
}

設定屬性

屬性	描述	預設
`createApicEntryForNewApis`	設定為 `true` ，讓開發人員 Proxy 為它偵測到且尚未在 API 中心註冊的 API 建立新的 API 專案。當設定為 `false` Dev Proxy 時，只會在命令提示字元中列出未註冊的 API。	`true`
`resourceGroupName`	Azure API 中心所在的資源組名。	無
`serviceName`	開發人員 Proxy 應該用來檢查應用程式中使用的 API 是否已註冊的 Azure API 中心實例名稱。	無
`subscriptionId`	Azure API 中心實例所在的 Azure 訂用帳戶標識碼。	無
`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，則會顯示錯誤，而 Dev Proxy 會停用它。使用這些工具之一登入 Azure，然後重新啟動 Dev Proxy 以使用 ApiCenterOnboardingPlugin 外掛程式。

如果您在 CI/CD 管線中使用 Dev Proxy，您可以將、resourceGroupName、 serviceName和 workspaceName 屬性的值subscriptionId傳遞為環境變數。若要使用環境變數，請在值 @名稱前面加上，例如：

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

在這裡範例中，外掛程式會將、、和屬性分別設定subscriptionId為、AZURE_RESOURCE_GROUP_NAME、 AZURE_APIC_INSTANCE_NAME和 AZURE_APIC_WORKSPACE_NAME 環境變數的值AZURE_SUBSCRIPTION_ID。workspaceNameserviceNameresourceGroupNameApiCenterOnboardingPlugin

共用方式為

ApiCenterOnboardingPlugin

外掛程式實例定義

設定範例

設定屬性

命令列選項

備註

其他資源