ApiCenterOnboardingEklentisi

Bir uygulamada kullanılan API'lerin belirtilen Azure API Center örneğine kaydedilip kaydedilmediğini denetler.

Eklenti örneği tanımı

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

Yapılandırma örneği

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default",
    "createApicEntryForNewApis": true
  }
}

Yapılandırma özellikleri

Mülk	Açıklama	Temerrüt
createApicEntryForNewApis	Geliştirme Proxy'sinin algıladığı ve HENÜZ API Center'a kaydedilmemiş API'ler için yeni API girişleri oluşturmasını sağlamak için true olarak ayarlayın. false Dev Proxy olarak ayarlandığında, komut isteminde yalnızca kayıtlı olmayan API'ler listelenir.	true
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

ApiCenterOnboardingPlugin eklentisi, bir uygulamada kullanılan API'lerin belirtilen Azure API Center örneğine kaydedilip kaydedilmediğini denetler. API'ler kayıtlı değilse, eklenti API Center örneğinde yeni API girişleri oluşturabilir.

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 ApiCenterOnboardingPlugin 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 workspaceName özelliklerinin değerlerini ortam değişkenleri olarak geçirebilirsiniz. Ortam değişkenlerini kullanmak için değerin adını @ekleyin, örneğin:

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME",
    "createApicEntryForNewApis": true
  }
}

Bu örnekte, ApiCenterOnboardingPlugin eklentisi subscriptionId, resourceGroupName, serviceNameve workspaceName ö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

Gölge API'leri bulma