檢查應用程式中所使用的 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，讓開發人員 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，它會顯示錯誤，而開發人員 Proxy 會停用它。 使用這些工具之一登入 Azure，然後重新啟動 Dev Proxy 以使用 ApiCenterOnboardingPlugin 外掛程式。
如果您在 CI/CD 管線中使用開發 Proxy，您可以將 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 環境變數的值。
