Reutilizar configurações de política em suas definições de política de Gerenciamento de API

  • Artigo

APLICA-SE A: Todas as camadas de gerenciamento de API

Este artigo mostra como criar e usar fragmentos de política em suas definições de política de Gerenciamento de API. Os fragmentos de política são trechos XML reutilizáveis e gerenciados centralmente que contêm uma ou mais configurações de política de Gerenciamento de API.

Os fragmentos de política ajudam a configurar políticas de forma consistente e a manter as definições de política sem a necessidade de repetir ou redigitar o código XML.

Um fragmento de política:

  • Deve ser XML válido contendo uma ou mais configurações de política
  • Pode incluir expressões de política, se uma política referenciada as suportar
  • É inserido como está em uma definição de política usando a política include-fragment

Limitações:

  • Um fragmento de política não pode incluir um identificador de seção de política (<inbound>, <outbound>, etc.) ou o <base/> elemento.
  • Atualmente, um fragmento de política não pode aninhar outro fragmento de política.
  • O tamanho máximo de um fragmento de política é de 32 KB.

Pré-requisitos

Se você ainda não tiver uma instância de Gerenciamento de API e uma API de back-end, consulte:

Embora não seja necessário, convém configurar uma ou mais definições de política. Você pode copiar elementos de política dessas definições ao criar fragmentos de política.

Vá para a sua instância de Gestão de API

  1. No portal do Azure, procure e selecione serviços de Gerenciamento de API.

    Selecionar serviços de gerenciamento de API

  2. Na página Serviços de Gerenciamento de API, selecione sua instância de Gerenciamento de API.

    Selecione sua instância de Gerenciamento de API

Criar um fragmento de política

  1. Na navegação à esquerda da instância de Gerenciamento de API, em APIs, selecione Fragmentos> de política+ Criar.

  2. Na janela Criar um novo fragmento de política, insira um Nome e uma Descrição opcional do fragmento de política. O nome deve ser exclusivo dentro da sua instância de Gerenciamento de API.

    Nome de exemplo: ForwardContext

  3. No editor de fragmentos de política XML, digite ou cole um ou mais elementos XML de política entre as <fragment> tags e </fragment> .

    Captura de tela mostrando o formulário Criar um novo fragmento de política.

    Por exemplo, o fragmento a seguir contém uma configuração de set-header política para encaminhar informações de contexto para um serviço de back-end. Esse fragmento seria incluído em uma seção de política de entrada. As expressões de política neste exemplo acessam a variável internacontext.

    <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. Selecione Criar. O fragmento é adicionado à lista de fragmentos de política.

Incluir um fragmento numa definição de política

Configure a política para inserir um fragmento include-fragment de política em uma definição de política. Para obter mais informações sobre definições de política, consulte Definir ou editar políticas.

  • Você pode incluir um fragmento em qualquer escopo e em qualquer seção de política, desde que a política ou políticas subjacentes no fragmento ofereçam suporte a esse uso.
  • Você pode incluir vários fragmentos de política em uma definição de política.

Por exemplo, insira o fragmento de política chamado ForwardContext na seção de política de entrada:

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

Gorjeta

Para ver o conteúdo de um fragmento incluído exibido na definição de política, selecione Calcular política efetiva no editor de políticas.

Gerenciar fragmentos de política

Depois de criar um fragmento de política, você pode exibir e atualizar as propriedades de um fragmento de política ou excluir o fragmento de política a qualquer momento.

Para exibir as propriedades de um fragmento de política:

  1. Na navegação à esquerda da instância de Gerenciamento de API, em APIs, selecione Fragmentos de política. Selecione o nome do seu fragmento.
  2. Na página Visão geral, revise as referências do documento Política para ver as definições de política que incluem o fragmento.
  3. Na página Propriedades, revise o nome e a descrição do fragmento de política. O nome não pode ser alterado.

Para editar um fragmento de política:

  1. Na navegação à esquerda da instância de Gerenciamento de API, em APIs, selecione Fragmentos de política. Selecione o nome do seu fragmento.
  2. Selecione Editor de políticas.
  3. Atualize as instruções no fragmento e selecione Aplicar.

Nota

A atualização afeta todas as definições de política em que o fragmento está incluído.

Para excluir um fragmento de política:

  1. Na navegação à esquerda da instância de Gerenciamento de API, em APIs, selecione Fragmentos de política. Selecione o nome do seu fragmento.
  2. Revise as referências do documento de política para obter definições de política que incluam o fragmento. Antes que um fragmento possa ser excluído, você deve remover as referências de fragmento de todas as definições de política.
  3. Depois que todas as referências forem removidas, selecione Excluir.

Conteúdos relacionados

Para obter mais informações sobre como trabalhar com políticas, consulte: