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

  • Makale

UYGULANANLAR: Tüm API Management katmanları

Bu makalede, 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.

İlke parçası:

Sınırlamalar:

  • İlke parçası, ilke bölümü tanımlayıcısını (<inbound>, <outbound>vb.) 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

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

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. Azure portalında API Management hizmetlerini arayın ve seçin.

    API Management hizmetlerini seçme

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

    API Management örneğinizi seçin

İlke parçası oluşturma

  1. API Management örneğinizin sol gezinti bölmesinde, API'ler altında İlke parçaları>+ Oluştur'u seçin.

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

    Örnek ad: ForwardContext

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

    Yeni ilke parçası oluşturma formunu 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 parça bir gelen ilkesi 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

İlkeyi, include-fragment ilke tanımına ilke parçası eklemek için yapılandırın. İlke tanımları hakkında daha fazla bilgi için bkz . İlkeleri ayarlama veya düzenleme.

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

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

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

İpucu

İ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, bir ilke parçasının özelliklerini görüntüleyebilir ve güncelleştirebilir veya ilke parçasını istediğiniz zaman silebilirsiniz.

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

  1. API Management örneğinizin sol gezinti bölmesinde, API'ler'in altında İ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 İlke belgesi başvurularını gözden geçirin.
  3. Özellikler sayfasında, ilke parçasının adını ve açıklamasını gözden geçirin. Ad değiştirilemez.

İlke parçasını düzenlemek için:

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

Not

Güncelleştirme, parçanın dahil edildiği tüm ilke tanımlarını etkiler.

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

  1. API Management örneğinizin sol gezinti bölmesinde, API'ler'in altında İlke parçaları'nı seçin. Parçanızın adını seçin.
  2. Parça içeren ilke tanımları için İlke belgesi başvurularını gözden geçirin. Bir parçanın silinebilmesi için ö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.

İlgili içerik

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