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

APLICA-SE A: todas as camadas do 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 do Azure. Os fragmentos de política são snippets XML centralmente gerenciados e reutilizáveis que contêm uma ou mais configurações de política de Gerenciamento de API.

Os fragmentos de política ajudam você a configurar políticas de forma consistente e 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 um XML válido que contenha uma ou mais configurações de política.
• Pode incluir expressões de política, se uma política referenciada der suporte a elas.
• É 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>por exemplo) 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:

• Criar uma instância do Gerenciamento de API do Azure
• Importar e publicar uma API

Embora não seja necessário, talvez você queira 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.

Navegar até a instância de Gerenciamento de API

1. No portal do Azure, pesquise e selecione Serviços de Gerenciamento de API:

   

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

   

Criar um fragmento de política

1. No painel esquerdo da instância de Gerenciamento de API, em APIs, selecione fragmentos de política. No painel Fragmentos de política , selecione + Criar.

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

   Nome do exemplo: ForwardContext

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

   

   Por exemplo, o fragmento a seguir contém uma configuração de política set-header 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 contextvariável interna.

   <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 em uma definição de política

Use a política include-fragment para inserir um fragmento de política em uma definição de política. Para obter mais informações sobre definições de políticas, 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 as políticas subjacentes no fragmento ofereçam suporte ao 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>
[...]

Gerenciar fragmentos de política

Depois de criar um fragmento de política, você pode exibir e atualizar suas propriedades ou excluí-lo a qualquer momento.

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

1. No painel esquerdo da instância de Gerenciamento de API, em APIs, selecione fragmentos de política. Selecione o nome do fragmento.
2. Na página Visão geral, examine as Referências de documento de política para ver as definições de política que incluem o fragmento.
3. Na página Propriedades , em Configurações, examine 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. No painel esquerdo da instância de Gerenciamento de API, em APIs, selecione fragmentos de política. Selecione o nome do fragmento.
2. Em Configurações, selecione Editor de política.
3. Atualize as instruções no fragmento e selecione Aplicar.

Para criar um fragmento de política:

1. No painel esquerdo da instância de Gerenciamento de API, em APIs, selecione fragmentos de política. Selecione o nome do fragmento.
2. Examine as Referências de documento de política para definições de política que incluem o fragmento. Antes de excluir um fragmento, 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údo relacionado

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

• Tutorial: Transformar e proteger sua API
• Referência de Política para uma lista completa das instruções de política e suas configurações
• Expressões de política
• Definir ou editar políticas
• Reutilizar configurações de política
• Repositório de snippets de política
• Repositório de playground de políticas
• Kit de ferramentas de políticas do Gerenciamento de API do Azure
• Obter assistência do Copilot para criar, explicar e solucionar problemas de políticas