Azure API Management ilkelerini ayarlama veya düzenleme

UYGULANANLAR: Tüm API Management katmanları

Bu makalede, Azure portalında ilke tanımlarını düzenleyerek API Management örneğinizde ilkeleri yapılandırma adımları gösterilmektedir. Her ilke tanımı, BIR API isteği ve yanıtı üzerinde sıralı olarak çalışan gelen ve giden deyimlerinin sırasını açıklayan bir XML belgesidir.

Portaldaki ilke düzenleyicisi, API yayımcılarının ilke tanımlarına ilke eklemesi ve düzenlemesi için kılavuzlu formlar sağlar. XML'yi doğrudan ilke kodu düzenleyicisinde de düzenleyebilirsiniz.

İlkeler hakkında daha fazla bilgi:

• İlkeye genel bakış
• İlke deyimlerinin ve ayarlarının tam listesi için ilke başvurusu
• İlke kod parçacıkları deposu
• Azure API Management ilke araç seti
• Azure'da Microsoft Copilot kullanarak ilke yazma

Önkoşullar

Api Management örneğine ve arka uç API'nize sahip değilseniz bkz:

• Azure API Management örneği oluşturma
• API içeri aktarma ve yayımlama

API Management örneğinize gidin

1. Azure portalında API Management hizmetlerini arayın ve seçin.

   

2. API Management hizmetleri sayfasında API Management örneğinizi seçin.

   

Portalda ilkeyi yapılandırma

Aşağıdaki örnekte, portaldaki ilke düzenleyicisinde iki seçenek kullanarak bir ilkenin nasıl yapılandırılır gösterilmektedir:

• Birçok ilkeyi yapılandırmayı basitleştirmek için kılavuzlu form tabanlı düzenleyici
• XML'yi doğrudan ekleyebileceğiniz veya düzenleyebileceğiniz bir kod düzenleyicisi

Bu örnekte, ilke belirli gelen IP adreslerinden gelen istekleri filtreler. Kapsamı seçili bir API olarak belirlenmiştir.

İlkeyi yapılandırmak için:

İlkeleri farklı kapsamlarda yapılandırma

API Management, ilke bölümlerinin her birinde birden çok kapsamda ilke tanımlarını yapılandırma esnekliği sağlar.

Genel kapsam

Genel kapsam, API Management örneğinizdeki Tüm API'ler için yapılandırılır.

1. API Management örneğinizin sol gezinti bölmesinde API'ler Tüm API'ler'i seçin.>

2. Tasarım sekmesini seçin.

   

3. İlke bölümünde, form tabanlı bir ilke düzenleyicisi kullanmak için + İlke ekle'yi seçin veya XML'yi doğrudan eklemek ve düzenlemek için /> (kod düzenleyicisi) simgesini seçin<.

4. Değişiklikleri API Management ağ geçidine hemen yaymak için Kaydet'i seçin.

Ürün kapsamı

Ürün kapsamı seçili bir ürün için yapılandırılır.

1. Soldaki menüden Ürünler'i ve ardından ilkeleri uygulamak istediğiniz ürünü seçin.

2. Ürün penceresinde İlkeler'i seçin.

   

3. İlke bölümünde, form tabanlı bir ilke düzenleyicisi kullanmak için + İlke ekle'yi seçin veya XML'yi doğrudan eklemek ve düzenlemek için /> (kod düzenleyicisi) simgesini seçin<.

4. Değişiklikleri API Management ağ geçidine hemen yaymak için Kaydet'i seçin.

API kapsamı

API kapsamı, seçilen API'nin Tüm işlemleri için yapılandırılır.

1. API Management örneğinizin sol gezinti bölmesinde API'leri ve ardından ilkeleri uygulamak istediğiniz API'yi seçin.

2. Tasarım sekmesini seçin.

3. Tüm işlemler’i seçin.

   

4. İlke bölümünde, form tabanlı bir ilke düzenleyicisi kullanmak için + İlke ekle'yi seçin veya XML'yi doğrudan eklemek ve düzenlemek için /> (kod düzenleyicisi) simgesini seçin<.

5. Değişiklikleri API Management ağ geçidine hemen yaymak için Kaydet'i seçin.

İşlem kapsamı

İşlem kapsamı seçili BIR API işlemi için yapılandırılır.

1. API Management örneğinizin sol gezinti bölmesinde API'ler'i seçin.

2. Tasarım sekmesini seçin.

3. İlkeleri uygulamak istediğiniz işlemi seçin.

   

4. İlke bölümünde, form tabanlı bir ilke düzenleyicisi kullanmak için + İlke ekle'yi seçin veya XML'yi doğrudan eklemek ve düzenlemek için /> (kod düzenleyicisi) simgesini seçin<.

5. Değişiklikleri API Management ağ geçidine hemen yaymak için Kaydet'i seçin.

İlke yapılandırmalarını yeniden kullanma

API Management örneğinizde yeniden kullanılabilir ilke parçaları oluşturabilirsiniz. İlke parçaları, bir veya daha fazla ilke yapılandırmanızı içeren XML öğeleridir. İlke parçaları, ilkeleri tutarlı bir şekilde yapılandırmanıza ve XML kodunu yinelemeye veya yeniden yazmanıza gerek kalmadan ilke tanımlarını korumanıza yardımcı olur.

İlke tanımına ilke parçası eklemek için ilkeyi include-fragment kullanın.

İlke değerlendirme sırasını ayarlamak için öğesini kullanma base

İlke tanımlarını birden fazla kapsamda yapılandırıyorsanız, API isteğine veya yanıtına birden çok ilke uygulanabilir. Farklı kapsamlardaki ilkelerin uygulanma sırasına bağlı olarak, isteğin veya yanıtın dönüşümü farklı olabilir.

API Management'ta, öğesinin her kapsamdaki ilke tanımındaki her bölüme yerleştirilerek base ilke değerlendirme sırasını belirleyin. öğesi, base bir sonraki daha geniş (üst) kapsamda bu bölümde yapılandırılan ilkeleri devralır. base öğesi varsayılan olarak her ilke bölümüne eklenir.

İlke düzenleyicisini kullanarak ilke değerlendirme sırasını değiştirmek için:

1. Yapılandırdığınız en dar kapsamdaki tanım ile başlayın. İlk olarak hangi API Management'ın uygulanacağı.

   Örneğin, genel kapsamda ve API kapsamında yapılandırılan ilke tanımlarını kullanırken, API kapsamındaki yapılandırmayla başlayın.

2. Üst kapsamda ilgili bölümden base tüm ilkelerin devralınacağı yeri belirlemek için öğesini bir bölüme yerleştirin.

   Örneğin, API kapsamında yapılandırılan bir inbound bölümde, genel kapsamdaki bölümde yapılandırılan inbound ilkelerin devralınacağı yeri denetlemek için bir base öğe yerleştirin. Aşağıdaki örnekte, genel kapsamdan devralınan ilkeler ilkeden ip-filter önce uygulanır.

   <policies>
     <inbound>
         <base />
           <ip-filter action="allow">
               <address>10.100.7.1</address>
           </ip-filter>
     </inbound>
     [...]
   </policies>
   

   Not

   • öğesini bir bölümdeki herhangi bir ilke öğesinin base önüne veya arkasına yerleştirebilirsiniz.
   • İlkelerin üst kapsamdan devralınmasını önlemek istiyorsanız öğesini kaldırın base . Çoğu durumda bu önerilmez. Ancak belirli durumlarda, örneğin belirli bir işleme API (tüm işlemler) kapsamı için yapılandırılandan farklı ilkeler uygulamak istediğinizde yararlı olabilir.

3. İlke tanımlarındaki öğesini ardışık olarak daha geniş kapsamlarda yapılandırmaya base devam edin.

   Genel kapsamlı bir ilkenin üst kapsamı yoktur ve içindeki öğesini kullanmanın base hiçbir etkisi yoktur.

Azure'da Microsoft Copilot kullanarak ilke oluşturma konusunda yardım alma (önizleme)

Azure'da Microsoft Copilot (önizleme), Azure API Management için ilke yazma özellikleri sağlar. Söz dizimini bilmeden belirli gereksinimlerinize uyan veya size açıklanmış ilkeleri önceden yapılandırmış ilkeler oluşturmak için Azure'da Api Management'ın ilke düzenleyicisi bağlamında Copilot kullanın.

Azure'da Copilot'tan ilke tanımları oluşturmasını isteyebilir, ardından sonuçları ilke düzenleyicisine kopyalayabilir ve gerekli ayarlamaları yapabilirsiniz. Farklı seçenekler hakkında içgörü elde etmek, sağlanan ilkeyi değiştirmek veya zaten sahip olduğunuz ilkeyi netleştirmek için sorular sorun. Daha fazla bilgi edinin

İlgili içerik

İlkelerle çalışma hakkında daha fazla bilgi için bkz:

• Öğretici: API'leri dönüştürme ve koruma
• İlkeleri ayarlama veya düzenleme
• İlke başvurusu
• İlke kod parçacıkları deposu
• Azure API Management ilke araç seti
• Azure'da Microsoft Copilot kullanarak ilke yazma