状態コードを設定する

適用対象: すべての API Management レベル

set-status ポリシーは、HTTP 状態コードを指定された値に変更します。

ポリシー ステートメント

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

属性

使用法

• ポリシー セクション: inbound、outbound、backend、on-error
• ポリシー スコープ: グローバル、ワークスペース、製品、API、操作
• ゲートウェイ: クラシック、v2、従量課金、セルフホステッド

例

この例は、承認トークンが無効な場合に 401 応答を返す方法を示しています。 詳細については、「Azure API Management サービスからの外部サービスの使用」を参照してください。

<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>

関連ポリシー

• 変換

関連するコンテンツ

ポリシーに対する処理の詳細については、次のトピックを参照してください。

• チュートリアル:API を変換および保護する
• ポリシー ステートメントとその設定の一覧に関するポリシー リファレンス
• ポリシー式
• ポリシーの設定または編集
• ポリシー構成を再利用する
• ポリシー スニペットのリポジトリ
• Azure で Microsoft Copilot を使用してポリシーを作成する