ApiCenterProductionVersionEklentisi

Bir uygulamada kullanılan API'lerin belirtilen Azure API Center örneğinde kayıtlı API'lerin üretim sürümü olup olmadığını denetler.

Yapılandırma örneği

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.2.0/rc.schema.json",
  "plugins": [
    {
      "name": "ApiCenterProductionVersionPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "apiCenterProductionVersionPlugin"
    }
  ],
  "apiCenterProductionVersionPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.2.0/apicenterproductionversionplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspace": "default"
  }
}

Yapılandırma özellikleri

Mülk	Açıklama	Temerrüt
resourceGroupName	Azure API Center'ın bulunduğu kaynak grubunun adı.	Hiç kimse
serviceName	Geliştirme Proxy'sinin uygulamada kullanılan API'lerin kayıtlı olup olmadığını denetlemek için kullanması gereken Azure API Center örneğinin adı.	Hiç kimse
subscriptionId	Azure API Center örneğinin bulunduğu Azure aboneliğinin kimliği.	Hiç kimse
workspace	Kullanılacak Azure API Center çalışma alanının adı.	default

Komut satırı seçenekleri

Hiç kimse

Açıklamalar

ApiCenterProductionVersionPlugin eklentisi, bir uygulamada kullanılan API'lerin belirtilen Azure API Center örneğinde kayıtlı API'lerin üretim sürümü olup olmadığını denetler. API'ler üretim dışı sürümler ile eşleşiyorsa eklenti bir uyarı gösterir.

Eklenti, Azure API Center'a bağlanmak için Azure kimlik bilgilerini kullanır (şu sırayla):

• Çevre
• İş Yükü Kimliği
• Yönetilen Kimlik
• Visual Studio
• Visual Studio Code
• Azure Komut Satırı Arayüzü (Azure CLI)
• Azure PowerShell
• Azure Geliştirici CLI'sı

Eklenti Azure'a erişmek için erişim belirteci alamazsa bir hata gösterir ve Dev Proxy bunu devre dışı bırakır. Bu araçlardan birini kullanarak Azure'da oturum açın ve ApiCenterProductionVersionPlugin eklentisini kullanmak için Dev Proxy'yi yeniden başlatın.

CI/CD işlem hatlarında Dev Proxy kullanıyorsanız, subscriptionId, resourceGroupName, serviceNameve workspace özelliklerinin değerlerini ortam değişkenleri olarak geçirebilirsiniz. Ortam değişkenlerini kullanmak için değerin adını @ekleyin, örneğin:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.2.0/rc.schema.json",
  "plugins": [
    {
      "name": "ApiCenterProductionVersionPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "apiCenterProductionVersionPlugin"
    }
  ],
  "apiCenterProductionVersionPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.2.0/apicenterproductionversionplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspace": "@AZURE_APIC_WORKSPACE_NAME"
  }
}

Bu örnekte, ApiCenterProductionVersionPlugin eklentisi subscriptionId, resourceGroupName, serviceNameve workspace özelliklerini sırasıyla AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEve AZURE_APIC_WORKSPACE_NAME ortam değişkenlerinin değerlerine ayarlar.

Sonraki adım

Uygulamamın üretim düzeyi API'leri kullanıp kullanmadiğini denetleme