状態コードを設定する
適用対象: すべての API Management レベル
set-status ポリシーは、HTTP 状態コードを指定された値に変更します。
Note
ポリシーの要素と子要素を、ポリシー ステートメントで指定された順序で設定します。 API Management ポリシーを設定または編集する方法について説明します。
ポリシー ステートメント
<set-status code="HTTP status code" reason="description"/>
属性
| 属性 | 説明 | 必要 | Default |
|---|---|---|---|
| code | 整数。 返される HTTP 状態コード。 ポリシー式を使用できます。 | はい | 該当なし |
| reason | 文字列 をオンにします。 状態コードを返す理由の説明。 ポリシー式を使用できます。 | はい | 該当なし |
使用法
- ポリシー セクション: 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 を使用してポリシーを作成する