Definir código de estado
APLICA-SE A: Todas as camadas de gerenciamento de API
A set-status política define o código de status HTTP para o valor especificado.
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
<set-status code="HTTP status code" reason="description"/>
Atributos
| Atributo | Description | Necessário | Predefinição |
|---|---|---|---|
| code | Inteiro. O código de status HTTP a ser retornado. São permitidas expressões de política. | Sim | N/A |
| reason | String. Uma descrição do motivo para retornar o código de status. São permitidas expressões de política. | Sim | N/A |
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
Exemplo
Este exemplo mostra como retornar uma resposta 401 se o token de autorização for inválido. Para obter mais informações, consulte Usando serviços externos do serviço de Gerenciamento de API do Azure.
<choose>
<when condition="@((bool)((IResponse)context.Variables["tokenstate"]).Body.As<JObject>()["active"] == false)">
<return-response response-variable-name="existing response variable">
<set-status code="401" reason="Unauthorized" />
<set-header name="WWW-Authenticate" exists-action="override">
<value>Bearer error="invalid_token"</value>
</set-header>
</return-response>
</when>
</choose>
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
- Criar políticas usando o Microsoft Copilot para Azure