Impostare il codice di stato

SI APPLICA A: Tutti i livelli di Gestione API

Il criterio set-status modifica il codice di stato HTTP sul valore specificato.

Nota

Impostare gli elementi e gli elementi figlio del criterio nell'ordine specificato nell'istruzione del criterio. Altre informazioni su come impostare o modificare i criteri di API Management.

Istruzione del criterio

<set-status code="HTTP status code" reason="description"/>

Attributi

Attributo	Descrizione	Richiesto	Valore predefinito
codice	Integer. Il codice di stato HTTP da restituire. Le espressioni di criteri sono consentite.	Sì	N/D
reason	String. Descrizione del motivo per la restituzione del codice di stato. Le espressioni di criteri sono consentite.	Sì	N/D

Utilizzo

• Sezioni del criterio: inbound, outbound, backend, on-error
• Ambiti del criterio: globale, area di lavoro, prodotto, API, operazione
• Gateway: classico, v2, consumo, self-hosted, area di lavoro

Esempio

Questo esempio illustra come restituire una risposta 401 se il token di autorizzazione non è valido. Per altre informazioni, vedere Uso di servizi esterni dal servizio API Management di 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>

Criteri correlati

• Trasformazione

Contenuto correlato

Per ulteriori informazioni sull'utilizzo dei criteri, vedere:

• Esercitazione: trasformare e proteggere l'API
• Informazioni di riferimento sui criteri per un elenco completo delle istruzioni dei criteri e delle relative impostazioni
• Espressioni di criteri
• Impostare o modificare criteri
• Riutilizzare le configurazioni dei criteri
• Repository dei frammenti di criteri
• Toolkit dei criteri di Azure Gestione API
• Creare criteri usando Microsoft Copilot in Azure