Resposta de retorno
APLICA-SE A: Todas as camadas de gerenciamento de API
A return-response
política cancela a execução do pipeline e retorna uma resposta padrão ou personalizada para o chamador. A resposta padrão é 200 OK
sem corpo. A resposta personalizada pode ser especificada por meio de uma variável de contexto ou instruções de política. Quando ambos são fornecidos, a resposta contida na variável de contexto é modificada pelas instruções de política antes de ser devolvida ao chamador.
Nota
Defina os elementos da política e os elementos filho na ordem fornecida na declaração de política. Saiba mais sobre como definir ou editar políticas de Gerenciamento de API.
Declaração de política
<return-response response-variable-name="existing context variable">
<set-status>...</set-status>
<set-header>...</set-header>
<set-body>...</set-body>
</return-response>
Atributos
Atributo | Description | Necessário | Predefinição |
---|---|---|---|
nome-variável-resposta | O nome da variável de contexto referenciada, por exemplo, de uma política de solicitação de envio upstream e que contém um Response objeto. Expressões de política não são permitidas. |
No | N/A |
Elementos
Elemento | Description | Obrigatório |
---|---|---|
set-status | Define o código de status da resposta. | Não |
set-header | Define um cabeçalho na resposta. | Não |
corpo-conjunto | Define o corpo na resposta. | Não |
Utilização
- Seções de política: entrada, saída, back-end, no erro
- Âmbitos de política: global, área de trabalho, produto, API, operação
- Gateways: clássico, v2, consumo, auto-hospedado, espaço de trabalho
Notas de utilização
- Um modelo líquido não funciona quando especificado dentro do corpo (definido usando
set-body
) dareturn-response
política. Areturn-response
política cancela o pipeline de execução atual e remove o corpo da solicitação e o corpo da resposta no contexto atual. Como resultado, um modelo líquido especificado dentro da política recebe uma cadeia de caracteres vazia como entrada e não produzirá a saída esperada.
Exemplo
<return-response>
<set-status code="401" reason="Unauthorized"/>
<set-header name="WWW-Authenticate" exists-action="override">
<value>Bearer error="invalid_token"</value>
</set-header>
</return-response>
Políticas relacionadas
Conteúdos relacionados
Para obter mais informações sobre como trabalhar com políticas, consulte:
- Tutorial: Transforme e proteja sua API
- Referência de política para uma lista completa de declarações de política e suas configurações
- Expressões de política
- Definir ou editar políticas
- Reutilizar configurações de política
- Recompra de trechos de política
- Kit de ferramentas de política de Gerenciamento de API do Azure
- Criar políticas usando o Microsoft Copilot no Azure