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 politika tanımı, bir API isteği ve yanıtı üzerinde sıralı olarak çalışan gelen ve giden ifadeler dizisini 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:

• Politikaya genel bakış
• Politika ifadelerinin ve ayarlarının tam listesi için Politika Referansı
• Politika parçacıkları deposu
• Azure API Management politika araç seti
• Azure Copilot kullanarak author policies

Önkoşullar

Eğer API Yönetimi birimine ve arka uç API'ye sahip değilseniz, bakınız:

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

API Management örneğinize gidin

1. Azureportalında API Management hizmetleriniarayıp seçin:

   

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

   

Portaldaki politikayı yapılandırın

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. Seçili bir API'ye yöneliktir.

Not

Tüm API'ler, bir ürün veya tek bir API işlemi gibi diğer kapsamlarda ilkeler yapılandırabilirsiniz. Diğer örnekler için bu makalenin devamında yer alan Kapsamı yapılandırma bölümüne bakın.

İlkeyi yapılandırmak için:

Form

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

2. Daha önce içeri aktardığınız bir API'yi seçin.

3. Tasarım sekmesini seçin.

4. İlkeyi tüm işlemlere uygulamak için Tüm işlemler'i seçin.

5. Gelen işleme bölümünde + İlke ekle'yi seçin.

   

6. Gelen ilke ekle bölümünde, eklenecek bir ilke seçin. Örneğin, IP adreslerini filtrele'yi seçin.

   

   İpucu

   • Gösterilen ilkelerin kapsamı, yapılandırmakta olduğunuz ilke bölümüyle (bu örnekte, gelen işleme için) belirlenmiştir.
   • İstediğiniz bir ilkeyi görmüyorsanız Diğer ilkeler kutucuğunu seçin. Bu işlem XML kod düzenleyicisini açar ve bu bölüm ve kapsam için ilkelerin tam listesini görüntüler.

7. İzin Verilen IP'lerve API isteğinde bulunmalarına izin verilen bir dizi gelen adresin ilk ve son IP adreslerini ekleyin. Gerekirse diğer IP adresi aralıklarını ekleyin.

   

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

   Ip filtresi ilkesi artık Gelen işleme bölümünde görünür.

Kod

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

2. Daha önce içeri aktardığınız bir API'yi seçin.

3. Tasarım sekmesini seçin.

4. İlkeyi tüm işlemlere uygulamak için Tüm işlemler'i seçin.

5. Gelen işleme bölümünde /<>.

   

6. Kullanılabilir ilke XML kod parçacıklarını görmek için Kod parçacıklarını göster'i seçin. Örneğin, Çağıran IP'lerini kısıtla'yı seçin.

   

7. İstediğiniz ilke kodu parçacığını uygun bloklardan birine yapıştırın veya girin ve ilke yapılandırmasını tamamlayın.

   <policies>
       <inbound>
           <base />
           <ip-filter action="allow">
               <address-range from="10.100.7.0" to="10.100.127.0" />
           </ip-filter>
       </inbound>
       <backend>
           <base />
       </backend>
       <outbound>
           <base />
       </outbound>
       <on-error>
           <base />
       </on-error>
   </policies>
   

   Not

   İlke bildiriminde belirlenen sıraya göre, ilkenin öğelerini ve alt öğelerini ayarlayın.

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

   Ip filtresi ilkesi artık Gelen işleme bölümünde görünür.

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

Önemli

Her kapsam veya ilke bölümünde tüm ilkeler uygulanamıyor. Eklemek istediğiniz ilke etkinleştirilmemişse, bu ilke için desteklenen bir bölümde ve geçerli kapsamda olduğunuzdan emin olun. bir ilkenin ilke bölümlerini ve kapsamlarını gözden geçirmek için, İlke başvuru konularının Kullanım bölümünü denetleyin.

Not

Arka uç ilkesi bölümü yalnızca bir ilke öğesi içerebilir. Varsayılan olarak, API Management ilkeyi genel kapsamdaki forward-request bölümünde ve öğesini diğer kapsamlarda yapılandırır.

Genel kapsam

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

1. API Yönetimi örneğinizin sol gezinti bölmesinde API'ler seçeneğini > olarak 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 /<>.

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

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 seçin 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 /<>.

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

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 bir ilke parçası eklemek için include-fragment ilkesini 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 Yönetimi'nde, her kapsamdaki ilke tanımının her bölümüne base öğesini yerleştirerek ilke değerlendirme sırasını belirleyin. base öğesi, 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.

Not

Geçerli kapsamdaki geçerli ilkeleri görüntülemek için, ilke düzenleyicisinde Etkin ilkeyi hesapla'yı seçin.

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

1. API Management'ın ilk olarak uygulayacağı, yapılandırdığınız en dar kapsamdaki tanım ile başlayın.

   Ö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. base öğesini, üst kapsamda ilgili bölümden tüm ilkelerin devralınacağı yeri belirlemek için bir bölüme yerleştirin.

   Örneğin, API kapsamında yapılandırılmış bir inbound bölümüne, genel kapsamda yapılandırılmış base bölümündeki ilkeleri devralma yerini kontrol etmek için bir inbound öğesi 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.
   • Eğer ilkelerin üst kapsamdan devralınmasını önlemek istiyorsanız, base öğesini kaldırın. Ç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ında base öğesini giderek daha geniş kapsamlarla yapılandırmaya devam edin.

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

Yardımı Copilot'tan al

API Management ilke tanımlarınızı oluşturmak ve düzenlemek için Copilot'tan yapay zeka yardımı alabilirsiniz. XML söz dizimini bilmenize gerek kalmadan özel gereksinimlerinize uyan ilkeler oluşturmak ve güncelleştirmek için Copilot'u kullanabilirsiniz. Ayrıca mevcut ilkelerin açıklamalarını da alabilirsiniz. Copilot, diğer API yönetim çözümlerinde yapılandırmış olabileceğiniz ilkeleri çevirmenize yardımcı olabilir.

• Azure Copilot , Azure portalında doğal dil istemleriyle ilke yazma yardımı sağlar. API Management ilke düzenleyicisinde ilkeler yazabilir ve Copilot'dan ilke bölümlerini açıklamasını isteyebilirsiniz.
• Visual Studio Code'da Azure için GitHub Copilot, ilke yazımını kolaylaştırıcı bir yardım sağlar ve ilke yapılandırmasını hızlandırmak için Visual Studio Code'daki Azure API Yönetimi Uzantısı'nı kullanabilirsiniz. İlke tanımlarını oluşturmak ve iyileştirmek için Copilot Chat veya Copilot Düzenlemeleri doğal dille yönlendirebilirsiniz.

Örnek komut:

Generate a policy that adds an Authorization header to the request with a Bearer token.

Copilot yapay zeka ile desteklendiğinden sürprizler ve hatalar mümkündür. Daha fazla bilgi için bkz. Copilot sıkça sorulan sorular.

İlgili içerik

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

• Öğretici: API'nizi dönüştürme ve koruma
• Politika ifadelerinin ve ayarlarının tam listesi için Politika Referansı
• Politika ifadeleri
• Politikaları ayarlama veya düzenleme
• Yeniden kullanım için ilke yapılandırmaları
• Politika parçacıkları deposu
• İlke oyun alanı deposu
• Azure API Management politika araç seti
• Politikalar oluşturmak, açıklamak ve sorun gidermek için Copilot yardımı alın