Aracılığıyla paylaş

API Management ilke tanımlarınızda ilke yapılandırmalarını yeniden kullanma

UYGULANANLAR: Tüm API Management katmanları

Bu makalede, Azure API Management ilke tanımlarınızda ilke parçalarının nasıl oluşturulacağı ve kullanılacağı gösterilmektedir. İlke parçaları, bir veya daha fazla API Management ilke yapılandırması içeren merkezi olarak yönetilen, yeniden kullanılabilir XML kod parçacıklarıdır.

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

Politika parçası:

  • Bir veya daha fazla ilke yapılandırması içeren geçerli BIR XML olmalıdır.
  • Başvuruda bulunılan bir ilke bunları destekliyorsa, ilke ifadelerini içerebilir.
  • include-fragment ilkesi aracılığıyla bir ilke tanımına as-is eklenir.

Sınırlamalar:

  • İlke parçası, ilke bölümü tanımlayıcısını (<inbound>örneğin, <outbound>) veya <base/> öğesini içeremez.
  • Şu anda, bir ilke parçası başka bir ilke parçasını iç içe yerleştiremez.
  • İlke parçasının boyutu üst sınırı 32 KB'tır.

Önkoşullar

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

Gerekli olmasa da, bir veya daha fazla ilke tanımı yapılandırmak isteyebilirsiniz. İlke parçaları oluştururken bu tanımlardan ilke öğelerini kopyalayabilirsiniz.

API Management örneğinize gidin

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

    Arama sonuçlarında API Management hizmetlerini gösteren ekran görüntüsü.

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

    API Yönetimi hizmetleri sayfasında bir API Yönetimi örneğini gösteren ekran görüntüsü.

İlke bölümü oluştur

  1. API Management örneğinizin sol bölmesindeki API'ler bölümünde İlke parçaları'nı seçin. Politika parçacıkları bölmesinde + Oluştur'u seçin.

  2. Yeni ilke parçası oluştur penceresinde bir Ad ve isteğe bağlı olarak ilke parçasının açıklamasını girin. Ad, API Management örneğinizde benzersiz olmalıdır.

    Örnek isim: ForwardContext

  3. XML ilkesi parçası düzenleyicisinde, <fragment> ve </fragment> etiketleri arasına bir veya daha fazla ilke XML öğesi yazın veya yapıştırın:

    Yeni ilke parçası oluştur penceresini gösteren ekran görüntüsü.

    Örneğin, aşağıdaki parça bağlam bilgilerini bir arka uç hizmetine iletmek için bir set-header ilke yapılandırması içerir. Bu bölüm gelen politika bölümüne eklenir. Bu örnekteki ilke ifadeleri yerleşik context değişkene erişmektedir.

    <fragment>
    <set-header name="x-request-context-data" exists-action="override">
      <value>@(context.User.Id)</value>
      <value>@(context.Deployment.Region)</value>
    </set-header>
</fragment>

  4. Oluştur'u belirleyin. Parça, ilke parçaları listesine eklenir.

İlke tanımına parça ekleme

İlke tanımına bir ilke parçası eklemek için include-fragment ilkesini kullanın. İlke tanımları hakkında daha fazla bilgi için bkz . İlkeleri ayarlama veya düzenleme.

  • Parçadaki temel ilke veya ilkeler kullanımı desteklediği sürece, herhangi bir kapsamda ve herhangi bir ilke bölümünde bir parça ekleyebilirsiniz.
  • İlke tanımına birden çok ilke parçası ekleyebilirsiniz.

Örneğin, ForwardContext adlı ilke parçasını gelen ilke bölümüne ekleyin.

<policies>
    <inbound>
        <include-fragment fragment-id="ForwardContext" />
        <base />
    </inbound>
[...]

Tavsiye

İlke tanımında görüntülenen bir parçanın içeriğini görmek için, ilke düzenleyicisinde Etkin ilkeyi hesapla'yı seçin.

İlke parçalarını yönetme

İlke parçası oluşturduktan sonra, özelliklerini görüntüleyebilir ve güncelleştirebilir veya istediğiniz zaman silebilirsiniz.

İlke parçasının özelliklerini görüntülemek için:

  1. API Management örneğinizin sol bölmesindeki API'ler bölümünde İlke parçaları'nı seçin. Parçanızın adını seçin.
  2. Genel Bakış sayfasında, parça içeren ilke tanımlarını görmek için Politika belgesi referanslarını gözden geçirin.
  3. Özellikler sayfasındaki Ayarlar'ın altında ilke parçasının adını ve açıklamasını gözden geçirin. Ad değiştirilemez.

Bir politika parçasını düzenlemek için:

  1. API Management örneğinizin sol bölmesindeki API'ler bölümünde İlke parçaları'nı seçin. Parçanızın adını seçin.
  2. Ayarlar'ın altında İlke düzenleyicisi'ni seçin.
  3. Parçadaki deyimleri güncelleştirin ve uygula'yı seçin.

Uyarı

Güncelleştirmeler, parçanın dahil olduğu tüm ilke tanımlarını etkiler.

İlke parçasını silmek için:

  1. API Management örneğinizin sol bölmesindeki API'ler bölümünde İlke parçaları'nı seçin. Parçanızın adını seçin.
  2. Policy belgesi referanslarını parça içeren ilke tanımları için gözden geçirin. Bir parçayı silmeden önce, parça başvurularını tüm ilke tanımlarından kaldırmanız gerekir.
  3. Tüm başvurular kaldırıldıktan sonra Sil'i seçin.

Politika parçaları kullanarak gelişmiş veri hatları oluşturma

Parçalar, istek ve yanıt yaşam döngüsü boyunca yürütülen özel davranışa sahip gelişmiş işlem hattı senaryoları oluşturmak için kullanılabilir. Parça tabanlı işlem hatları için temel öneriler şunlardır:

  • Modülerlik - Her parçayı belirli bir endişeye odaklanan tek ve iyi tanımlanmış bir sorumlulukla tasarlar.
  • Veri paylaşımı - Parçalar arasında veri paylaşımı için bağlam değişkenlerini ve merkezi meta verileri önbelleğe alma özelliğini kullanın.
  • Parça yürütme davranışı - Kapsam temelinde ürün ve API ilkesi tanımlarına parçaları sırayla ekleyerek yürütme davranışını tanımlayın.
  • Performans iyileştirme - Maksimum verimlilik için performans yönergelerini izleyin.

Gelişmiş işlem hattı kılavuzu

Gelişmiş ilke parçası tasarımları oluşturma konusunda tam yönergeler için şu makalelere bakın:

İlgili içerik

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

  • Last updated on