Aracılığıyla paylaş

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

Bu makalede, örneklerin API'lerinin API merkezi envanterinizde sürekli olarak güncel tutulması amacıyla bir API Yönetimi örneğinin nasıl entegre edileceği gösterilmektedir.

Tavsiye

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.

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.
  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.

Uyarı

  • Tümleşik API Management örneklerinin (API kaynakları) sayısı için sınırlar vardır.
  • Entegre bir API Yönetim örneği sanal bir ağda yapılandırılabilir.
  • 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.

Varlık API Center'da yapılandırılabilir özellikler Tümleşik API kaynağında belirlenen özellikler
Uygulama Programlama Arayüzü (API) özet
yaşam döngüsü aşaması
hizmet şartları
lisans
Dış Belgeler
özelÖzellikler		 başlık
Açıklama
tür
API sürümü yaşam döngüsü aşaması başlık
tanımlar (eşitlenmişse)
Çevre başlık
Açıklama
tür
sunucu.yönetimPortalıURI
uyum süreci
özelÖzellikler		 sunucu.türü
Dağıtım başlık
Açıklama
sunucu
devlet
özelÖzellikler		 sunucu.çalışmaZamanıURI

Uyarı

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

Önkoşullar

  • Azure aboneliğinizde bir API merkezi. Henüz 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:

    Uyarı

    az apic komutları Için Azure CLI uzantısı gerekir apic-extension . Komutları kullanmadıysanız az apic , ilk az apic komutunuzu çalıştırdığınızda uzantı dinamik olarak yüklenebilir veya uzantıyı el ile yükleyebilirsiniz. Azure CLI uzantıları hakkında daha fazla bilgi edinin.

    En son değişiklikler ve güncellemeler için sürüm notlarına bakın apic-extension. Bazı özellikler, uzantının önizlemesini veya belirli bir sürümünü gerektirebilir.

    Uyarı

    Bu makaledeki Azure CLI komut örnekleri PowerShell veya bash kabuğunda çalıştırılabilir. Farklı değişken söz dizimi nedeniyle gerektiğinde, iki kabuk için ayrı komut örnekleri sağlanır.

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.

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

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.

  1. Portalda, API Management ö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şimi Ata - Yönetilen kimliği seçin>+ Üyeleri Seç.
    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.

API Management örneğini tümleştirme

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

  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ştirin sayfasında:
    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 API Management hizmetini portalda tümleştirme işleminin ekran görüntüsü.

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.

  1. Portalda API merkezinize gidin.
  2. Varlıklar altında Ortamlar>Entegrasyonlar (Önizleme)'yı seçin.
  3. Tümleştirmeyi seçin, ardından Sil (çöp kutusu simgesi) seçeneğini tıklayın.

İlgili içerik