ApiCenterProductionVersionPlugin

Memeriksa apakah API yang digunakan dalam aplikasi adalah versi produksi API yang terdaftar dalam instans Azure API Center yang ditentukan.

Definisi instans plugin

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

Contoh konfigurasi

{
  "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"
  }
}

Properti konfigurasi

Harta benda	Deskripsi	Bawaan
resourceGroupName	Nama grup sumber daya tempat Azure API Center berada.	Tidak
serviceName	Nama instans Azure API Center yang harus digunakan Dev Proxy untuk memeriksa apakah API yang digunakan dalam aplikasi terdaftar.	Tidak
subscriptionId	ID langganan Azure tempat instans Azure API Center berada.	Tidak
workspace	Nama ruang kerja Azure API Center yang akan digunakan.	default

Opsi baris perintah

Tidak

Komentar

Plugin ApiCenterProductionVersionPlugin memeriksa apakah API yang digunakan dalam aplikasi adalah versi produksi API yang terdaftar dalam instans Azure API Center yang ditentukan. Jika API cocok dengan versi nonproduksi, plugin akan menampilkan peringatan.

Untuk menyambungkan ke Azure API Center, plugin menggunakan kredensial Azure (dalam urutan ini):

• Lingkungan
• Identitas Beban Kerja
• Identitas Terkelola
• Visual Studio
• Visual Studio Code
• Azure CLI (antarmuka baris perintah Azure)
• Azure PowerShell
• Azure Developer CLI (Antarmuka Baris Perintah untuk Pengembang Azure)

Jika plugin gagal mendapatkan token akses untuk mengakses Azure, plugin menunjukkan kesalahan dan Proksi Dev menonaktifkannya. Masuk ke Azure menggunakan salah satu alat ini, dan mulai ulang Dev Proxy untuk menggunakan plugin ApiCenterProductionVersionPlugin.

Jika Anda menggunakan Dev Proxy di alur CI/CD, Anda dapat meneruskan nilai untuk properti subscriptionId, resourceGroupName, serviceName, dan workspaceName sebagai variabel lingkungan. Untuk menggunakan variabel lingkungan, tambahkan nama nilai dengan @, misalnya:

{
  "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"
  }
}

Dalam contoh ini, plugin ApiCenterProductionVersionPlugin menetapkan properti subscriptionId, resourceGroupName, serviceName, dan workspaceName ke nilai variabel lingkungan AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAME, dan AZURE_APIC_WORKSPACE_NAME .

Langkah selanjutnya

Cara memeriksa apakah aplikasi saya menggunakan API tingkat produksi