API Management örneğinden API'leri eşitleme

Bu makale, API Management örneğinin API'lerinin, API merkezi envanterinizde sürekli olarak güncel tutulmasını sağlamak için nasıl tümleştirildiğini gösterir.

Tip

Bu makalede, API Management örneğinizin API merkezinize nasıl tümleştirileceği açıklanmaktadır. Alternatif olarak, doğrudan bir API Yönetimi örneğinden tümleştirmeyi hızla ayarlayın. Örneğinizin sol menüsünde, API'ler'in altında API Center'ı seçin ve API'leri eşitlemek için aboneliğinizde bir hedef API merkezi seçin.

Note

API Center Standard artık Standart, Standart v2, Premium veya Premium v2 katmanındaki bir API Management örneğine bağladığınızda ek ücret ödemeden kullanılabilir. Daha fazla bilgi için bkz. API Center planları ve özellikleri.

API Management örneğini tümleştirme hakkında

Azure API Management'tan Azure API Center'a isteğe bağlı OLARAK API'leri içeri aktarmak için Azure CLI'yi kullanabilirsiniz ancak API Management örneğini tümleştirmek (bağlamak) SÜREKLI eşitlemeyi etkinleştirir ve böylece API envanteri güncel kalır. Azure API Center, Amazon API Gateway dahil olmak üzere kaynaklardan API'leri de eşitleyebilir.

BIR API Management örneğini API kaynağı olarak tümleştirdiğinizde aşağıdakiler gerçekleşir:

1. API Management örneğindeki tüm API'ler ve isteğe bağlı OLARAK API tanımları (belirtimler) API merkezi envanterine eklenir. API Management'taki MCP sunucuları ve A2A aracı API'leri envantere eklenen API'lere dahil edilir.
2. API merkezinde Azure API Management türünde bir ortam yapılandırabilirsiniz.
3. API Management'tan eşitlenen her API tanımı için ilişkili bir dağıtım oluşturulur.

API Management API'leri, mevcut API'lerin ayarları her değiştiğinde (örneğin, yeni sürümler eklendiğinde), yeni API'ler oluşturulduğunda veya API'ler silindiğinde api merkezine otomatik olarak eşitlenir. Bu eşitleme, API Management'tan Azure API merkezinize tek yönlüdür; yani API merkezindeki API güncelleştirmeleri API Management örneğine geri eşitlenmez.

Note

• Tümleşik API Management örneklerinin (API kaynakları) sayısı için sınırlar vardır.
• Sanal ağda tümleşik bir API Management örneği yapılandırabilirsiniz.
• API Management'taki API güncelleştirmeleri genellikle dakikalar içinde API merkezinizle eşitlenir, ancak eşitleme 24 saate kadar sürebilir.
• Tümleştirme sırasında dahil etme seçeneğini seçerseniz API tanımları da API merkeziyle eşitlenir.

API Management'tan eşitlenen varlıklar

Proje katılımcılarının API'leri bulmasına, anlamasına ve kullanmasına yardımcı olmak için API merkezinizdeki eşitlenmiş API'lere meta veri özellikleri ve belgeleri ekleyebilir veya güncelleştirebilirsiniz. Azure API Center'ın yerleşik ve özel meta veri özellikleri hakkında daha fazla bilgi edinin.

Aşağıdaki tabloda, Azure API Center'da değiştirilebilen varlık özellikleri ve API kaynağındaki değerlerine göre ayarlanan özellikler gösterilmektedir.

Entity	API Center'da yapılandırılabilir özellikler	Tümleşik API kaynağında belirlenen özellikler
API	summary lifecycleStage termsOfService license externalDocumentation customProperties	title description kind
API sürümü	lifecycleStage	title tanımlar (eşitlenmişse)
Environment	title description tür sunucu.yönetimPortalıURI onboarding customProperties	server.type
Deployment	title description server state customProperties	server.runtimeUri

Note

Azure API Center ile eşitlenen varlıklar için kaynak ve sistem kimlikleri otomatik olarak oluşturulur ve değiştirilemez.

Prerequisites

• Azure aboneliğinizde bir API merkezi. API merkezi oluşturmadıysanız bkz . Hızlı Başlangıç: API merkezinizi oluşturma.

• Aynı veya farklı bir abonelikte bir Azure API Management örneği. Örnek aynı dizinde olmalıdır.

• Azure CLI için:

  • Azure Cloud Shell'de Bash ortamını kullanın. Daha fazla bilgi için bkz. Azure Cloud Shell'i kullanmaya başlama.

    

  • CLI referans komutlarını yerel olarak çalıştırmayı tercih ediyorsanız, Azure CLI'yi yükleyin. Windows veya macOS üzerinde çalışıyorsanız, Azure CLI'yi bir Docker konteynerinde çalıştırmayı düşünün. Daha fazla bilgi için Azure CLI'nin bir Docker konteynerında nasıl çalıştırılacağını inceleyin.

    • Yerel bir kurulum kullanıyorsanız, az login komutunu kullanarak Azure CLI'ye giriş yapın. Kimlik doğrulama işlemini tamamlamak için, terminalinizde görüntülenen adımları takip edin. Diğer oturum açma seçenekleri için bkz. Azure CLI kullanarak Azure'da kimlik doğrulaması.

    • İstendiğinde, ilk kullanımda Azure CLI uzantısını yükleyin. Uzantılar hakkında daha fazla bilgi için bkz. Azure CLI ile uzantıları kullanma ve yönetme.

    • Yüklü olan sürümü ve bağımlı kütüphaneleri bulmak için az version komutunu çalıştırın. En son sürüme yükseltmek için az upgrade komutunu çalıştırın.

  Note

  az apic komutları, apic-extension Azure CLI uzantısı gerektirir. uzantı, ilk az apic komutunuzu çalıştırdığınızda dinamik olarak yüklenebilir veya uzantıyı el ile yükleyebilirsiniz. Daha fazla bilgi için bkz . Azure CLI Uzantılarını Yönetme: Yükleme, Güncelleştirme ve Kaldırma.

  içindeki apic-extensionen son değişiklikler ve güncelleştirmeler için sürüm notlarını inceleyin. Bazı özellikler için bir önizleme veya uzantının belirli bir sürümü gerekebilir.

  Note

  PowerShell'de veya bash kabuğunda bu makalede Azure CLI komut örneklerini çalıştırabilirsiniz. Farklı değişken söz dizimi gerektiğinde, makale iki kabuk için ayrı komut örnekleri sağlar.

API merkezinizde yönetilen kimliği etkinleştirme

Bu senaryoda, API merkeziniz Azure kaynaklarına erişmek için yönetilen kimlik kullanır. Gereksinimlerinize bağlı olarak, sistem tarafından atanan veya kullanıcı tarafından atanan bir veya daha fazla yönetilen kimliği etkinleştirin.

Aşağıdaki örneklerde, Azure portalını veya Azure CLI'yı kullanarak sistem tarafından atanan yönetilen kimliğin nasıl etkinleştirileceği gösterilmektedir. Yüksek düzeyde yapılandırma adımları, kullanıcı tarafından atanan yönetilen kimlik için benzerdir.

Portal

1. Portalda API merkezinize gidin.
2. Kenar çubuğu menüsünde, Güvenlik'in altında Yönetilen kimlikler'i seçin.
3. Sistem tarafından atanan'ı seçin ve durumu Açık olarak ayarlayın.
4. Kaydetseçeneğini seçin.

Azure CLI

Aşağıdaki az apic update komutunu kullanarak API merkezinizde sistem tarafından atanan kimliği ayarlayın. API merkezinizin ve kaynak grubunuzun adlarını yazın:

az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'

Yönetilen kimliği API Management Hizmet Okuyucusu rolüne atama

API'lerin içeri aktarılmasına izin vermek için API Center'ınızın yönetilen kimliğini API Management örneğinizdeki API Management Hizmet Okuyucusu rolünü atayın. Portalı veya Azure CLI'yi kullanabilirsiniz.

Portal

1. Portala API Yönetim örneğinize gidin.
2. Sol menüde Erişim denetimi (IAM) öğesini seçin.
3. + Rol ataması ekle'yi seçin.
4. Rol ataması ekle sayfasında, değerleri aşağıdaki gibi ayarlayın:
   1. Rol sekmesinde API Management Hizmet Okuyucusu'na tıklayın.
   2. Üyeler sekmesinde, Erişim atayacak seçeneğinin altında - Yönetilen kimlik seçin >.
   3. Yönetilen kimlikleri seçin sayfasında, önceki bölümde eklediğiniz API merkezinizin sistem tarafından atanan yönetilen kimliğini seçin. Seç'e tıklayın.
   4. Gözden geçir + ata'yı seçin.

Azure CLI

1. Kimliğin asıl kimliğini alın. Sistem tarafından atanan kimlik için az apic show komutunu kullanın.

   #! /bin/bash
   apicObjID=$(az apic show --name <api-center-name> \
       --resource-group <resource-group-name> \
       --query "identity.principalId" --output tsv)
   

   # Formatted for PowerShell
   $apicObjID=$(az apic show --name <api-center-name> `
       --resource-group <resource-group-name> `
       --query "identity.principalId" --output tsv)
   

2. az apim show komutunu kullanarak API Management örneğinizin kaynak kimliğini alın.

   #! /bin/bash
   apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

   # Formatted for PowerShell
   $apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

3. az role assignment create komutunu kullanarak API Management örneğinizdeki API Management Hizmet Okuyucusu rolünü yönetilen kimliğe atayın.

   #! /bin/bash
   scope="${apimID:1}"
   
   az role assignment create \
       --role "API Management Service Reader Role" \
       --assignee-object-id $apicObjID \
       --assignee-principal-type ServicePrincipal \
       --scope $scope 
   

   # Formatted for PowerShell
   $scope=$apimID.substring(1)
   
   az role assignment create `
       --role "API Management Service Reader Role" `
       --assignee-object-id $apicObjID `
       --assignee-principal-type ServicePrincipal `
       --scope $scope 
   

API Management örneğini tümleştirme

Api Management örneğini, portalı veya Azure CLI'yi kullanarak tümleştirebilirsiniz.

Portal

1. Portalda API merkezinize gidin.
2. Platformlar'ın altında Tümleştirmeler'i seçin.
3. + Azure API Management'tan> seçin.
4. Azure API Management Hizmetinizi tümleştirme bölümünde:
   1. API Management örneğindeki tüm API'lerin mi yoksa yalnızca API Management çalışma alanında bulunan API'lerin mi eşitleneceğini seçin.
   2. Tümleştirmek istediğiniz Abonelik, Kaynak grubu ve Azure API Management hizmetini seçin. Bir çalışma alanından yalnızca API'leri eşitlemek istiyorsanız, Çalışma alanı seçin bölümünden bir seçim yapın.
   3. Tümleştirme ayrıntıları'nda bir tanımlayıcı girin. API Management örneğine erişimi olan bir yönetilen kimliği henüz yapılandırmadıysanız, Yönetilen kimliği otomatik olarak yapılandır'ı etkinleştirin ve izinleri atayın. Bu seçim, API Center'ın sistem tarafından atanan yönetilen kimliğine API Management örneğinden API'leri eşitlemek için gerekli izinleri otomatik olarak atar.
   4. Ortam ayrıntıları'nda bir Ortam başlığı (ad), Ortam türü ve isteğe bağlı Açıklama girin.
   5. API Ayrıntıları'nda:
      1. Eşitlenen API'ler için bir Yaşam Döngüsü seçin. (API'ler API merkezinize eklendikten sonra bu değeri güncelleştirebilirsiniz.)
      2. İsteğe bağlı olarak, eşitlenmiş API'lere API tanımlarının eklenip eklenmeyeceğini seçin.
5. Oluştur'i seçin.

Azure CLI

API Management örneğini API merkezinizle tümleştirmek için az apic integration create apim komutunu çalıştırın.

• Kaynak grubunun, API merkezinin ve tümleştirmenin adlarını sağlayın.

• API Management örneği ve API merkezi aynı kaynak grubundaysa, API Management örneği adını değeri azure-apimolarak sağlayabilirsiniz. Aksi takdirde Azure kaynak kimliğini belirtin.

az apic integration create apim \
    --resource-group <resource-group-name> \
    --service-name <api-center-name> \
    --integration-name <apim-integration-name> \
    --azure-apim <apim-instance-name>

API Management örneği, API merkezinizde bir ortam olarak entegre edilir. API Yönetim API'leri API merkezi envanterine eşitlenir.

Tümleştirmeyi silme

Bir API kaynağı tümleştirilmiş olsa da, eşitlenmiş API'leri API merkezinizden silemezsiniz. Gerekirse tümleştirmeyi silebilirsiniz. Tümleştirmeyi sildiğinizde:

• API merkezi envanterinizdeki eşitlenmiş API'ler silinir
• API kaynağıyla ilişkili ortam ve dağıtımlar silinir

Portalı veya Azure CLI'yi kullanarak tümleştirmeyi silebilirsiniz.

Portal

1. Portalda API merkezinize gidin.
2. Varlıklar altında, Ortamlar>Tümleştirmeler seçin.
3. Tümleştirmeyi seçin, ardından Sil (çöp kutusu simgesi) butonuna tıklayın.

Azure CLI

Tümleştirmeyi silmek için az apic integration delete komutunu çalıştırın. Kaynak grubunun, API merkezinin ve tümleştirmenin adlarını sağlayın.

az apic integration delete \
    --resource-group <resource-group-name> \
    --service-name <api-center-name> \
    --integration-name <integration-name> \

İlgili içerik

• Azure CLI komutları ile API envanteri yönetme
• API Management'tan Azure API merkezinize API'leri içeri aktarma
• API merkezinizde MCP sunucularını kaydetme ve bulma
• Azure API Management belgeleri