Amazon API Gateway'den Azure API Center'a API'leri eşitleme (önizleme)

Bu makale, Amazon API Gateway'i entegre ederek ağ geçidinin API'lerini API merkezi envanterinizde sürekli olarak güncel tutmayı gösterir.

Amazon API Gateway'i tümleştirme hakkında

Amazon API Gateway'i API merkeziniz için bir API kaynağı olarak tümleştirmek, API envanterinin güncel kalması için sürekli eşitlemeyi etkinleştirir. Azure API Center, Azure API Management dahil olmak üzere kaynaklardan API'leri de eşitleyebilir.

Bir Amazon API Gateway'i API kaynağı olarak tümleştirdiğinizde aşağıdakiler gerçekleşir:

1. API Gateway'den API'ler ve isteğe bağlı API tanımları (belirtimler), API merkezi envanterine eklenir.
2. API merkezinde Amazon API Gateway türünde bir ortam yapılandırabilirsiniz.
3. Eşitlenen her API tanımı için ilişkili bir dağıtım oluşturulur.

Eşitleme, Amazon API Gateway'den Azure API merkezinize tek yönlüdür; yani API merkezindeki API güncelleştirmeleri Amazon API Gateway'e geri eşitlenmez.

Uyarı

• Amazon API Gateway tümleştirmesi şu anda önizleme aşamasındadır.
• Tümleşik API kaynaklarının sayısı için sınırlar vardır.
• Amazon API Gateway'deki API'ler, saatte bir API merkezinizle eşitlenir. Yalnızca REST API'leri eşitlenir.
• Tümleştirme sırasında dahil etme seçeneğini seçerseniz API tanımları da API merkeziyle eşitlenir. Yalnızca dağıtılan API'lerden gelen tanımlar eşitlenir.

Amazon API Gateway'den 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)
Ortam	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.

• Bir Azure anahtar kasası. Anahtar kasası oluşturmanız gerekiyorsa, Hızlı Başlangıç: Azure portalını kullanarak anahtar kasası oluşturma'ya bakın. Anahtar kasasına gizli dizi eklemek veya yönetmek için en azından Key Vault Gizli DiziLeri Yetkilisi rolü veya eşdeğer izinler gereklidir.

• Bir Amazon API Gateway.

• Bir ilkenin eklendiği bir AWS IAM kullanıcı kimliği.

• 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 başvuru komutlarını yerel olarak çalıştırmayı tercih ediyorsanız Azure CLI'yı yükleyin . Windows veya macOS üzerinde çalışıyorsanız Azure CLI’yi bir Docker kapsayıcısında çalıştırmayı değerlendirin. Daha fazla bilgi için bkz . Docker kapsayıcısında Azure CLI'yi çalıştırma.

    • Yerel yükleme kullanıyorsanız az login komutunu kullanarak Azure CLI ile oturum açın. Kimlik doğrulama işlemini tamamlamak için terminalinizde görüntülenen adımları izleyin. 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ü sürümü ve bağımlı kitaplıkları 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.

  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.

IAM kullanıcı erişim anahtarları oluşturma

API merkezinizin kimliğini Amazon API Gateway'de doğrulamak için AWS IAM kullanıcısına yönelik erişim anahtarları gerekir.

AWS Yönetim Konsolu'nu kullanarak gerekli erişim anahtarı kimliğini ve gizli anahtarı oluşturmak için AWS belgelerinde Kendiniz için erişim anahtarı oluşturma bölümüne bakın.

Erişim anahtarlarınızı güvenli bir konuma kaydedin. Sonraki adımlarda bunları Azure Key Vault'ta depolayacaksınız.

Dikkat

Erişim anahtarları uzun vadeli kimlik bilgileridir ve bunları parola gibi güvenli bir şekilde yönetmeniz gerekir. Erişim anahtarlarının güvenliğini sağlama hakkında daha fazla bilgi edinin

IAM kullanıcı erişim anahtarlarını Azure Key Vault'ta depolama

Aşağıdaki tabloda önerilen yapılandırmayı kullanarak iki IAM kullanıcı erişim anahtarını Azure Key Vault'ta el ile karşıya yükleyin ve güvenli bir şekilde depolayın. Daha fazla bilgi için bkz . Hızlı Başlangıç: Azure portalını kullanarak Azure Key Vault'tan gizli dizi ayarlama ve alma.

AWS gizli anahtarı	Karşıya yükleme seçenekleri	İsim	Gizli değer
Erişim anahtarı	Kılavuz	aws-access-key	AWS'den alınan erişim anahtarı kimliği
Gizli dizi erişim anahtarı	Kılavuz	AWS Gizli Erişim Anahtarı	AWS'den alınan gizli erişim anahtarı

Her gizli anahtarın Gizli dizi tanımlayıcısını ve benzeri bir URI'yi https://<key-vault-name>.vault.azure.net/secrets/<secret-name>not alın. Sonraki adımlarda bu tanımlayıcıları kullanacaksınız.

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. 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. Kaydet'i 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ğe Key Vault Sırları Kullanıcı rolünü atayın.

API'lerin içeri aktarılmasına izin vermek için API merkezinizin yönetilen kimliğini Azure anahtar kasanızdaki "Key Vault Secrets User" rolüne atayın. Portalı veya Azure CLI'yi kullanabilirsiniz.

Portal

1. Portaldan anahtar kasanıza 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 Key Vault Gizli Dizileri Kullanıcısı seçin.
   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.

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 keyvault show komutunu kullanarak anahtar kasanızın kaynak kimliğini alın.

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

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

3. Yönetilen kimliği anahtar kasanızdaki Key Vault Gizli Dizileri Kullanıcı rolünü az role assignment create komutuyla atayın.

   #! /bin/bash
   scope="${kvID:1}"
   
   az role assignment create \
       --role "Key Vault Secrets User" \
       --assignee-object-id $apicObjID \
       --assignee-principal-type ServicePrincipal \
       --scope $scope 
   

   # Formatted for PowerShell
   $scope=$apimID.substring(1)
   
   az role assignment create `
       --role "Key Vault Secrets User" `
       --assignee-object-id $apicObjID `
       --assignee-principal-type ServicePrincipal `
       --scope $scope 
   

Amazon API Gateway'i tümleştirme

Portalı veya Azure CLI'yi kullanarak Amazon API Gateway'i tümleştirebilirsiniz.

Portal

1. Portalda API merkezinize gidin.
2. Platformlar'ın altında Tümleştirmeler'i seçin.
3. + Amazon API Gateway'den> seçin.
4. Amazon API Gateway Hizmetinizi tümleştirin sayfasında:
   1. AWS erişim anahtarı ve AWS gizli dizi erişim anahtarı için Seç'e tıklayın ve depoladığınız aboneliği, anahtar kasasını, gizli diziyi seçin.
   2. Amazon API Gateway'in dağıtıldığı AWS bölgesini seçin.
   3. Tümleştirme ayrıntıları'nda bir tanımlayıcı girin.
   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

Bir Amazon API Gateway'i API merkezinizle tümleştirmek için az apic integration create aws (önizleme) komutunu çalıştırın.

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

• AWS erişim anahtarı ve gizli erişim anahtarı ile Amazon API Gateway'in dağıtıldığı AWS bölgesi için Key Vault gizli dizi tanımlayıcılarını sağlayın.

az apic integration create aws \
    --resource-group <resource-group-name> \
    --service-name-name <api-center-name> \
    --integration-name <aws-integration-name> \
    --aws-access-key-reference <access-key-uri> \
    --aws-secret-access-key-reference <secret-access-key-uri> 
    --aws-region-name <aws-region>

Ortam API merkezinize eklenir. Amazon API Gateway API'leri API center envanterine aktarılır.

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>Entegrasyonlar (Önizleme)'yı seçin.
3. Tümleştirmeyi seçin, ardından Sil (çöp kutusu simgesi) seçeneğini tıklayın.

Azure CLI

az apic integration delete (önizleme) komutunu çalıştırarak bir tümleştirmeyi silin. 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 eşitleme