Application Gateway での WebSocket のサポートの概要

[アーティクル]
11/06/2024

Application Gateway では、あらゆる規模のゲートウェイで WebSocket がネイティブにサポートされます。ユーザーが構成可能な、WebSocket のサポートを選択的に有効または無効にするための設定はありません。

RFC6455 で標準化された WebSocket プロトコルは、長時間に及ぶ TCP 接続上でサーバーとクライアント間の全二重通信を可能にします。この機能により、HTTP ベースの実装では必須だったポーリングを使用することなく、Web サーバーとクライアントの間により対話的な双方向通信が可能になります。 WebSocket は、HTTP とは異なってオーバーヘッドが少なく、複数の要求や応答で同じ TCP 接続を再利用できるため、リソースをより効率的に使用できます。 WebSocket プロトコルは、従来の HTTP ポート 80 および 443 上で動作するよう設計されています。

これまでどおり標準の HTTP リスナーをポート 80 または 443 で使用して WebSocket トラフィックを受信することができます。 WebSocket トラフィックは、アプリケーションゲートウェイの規則で指定されている適切なバックエンドプールを使用して、WebSocket が有効なバックエンドサーバーに送られます。バックエンドサーバーは、アプリケーションゲートウェイプローブに応答する必要があります (アプリケーションゲートウェイプローブについては、正常性プローブの概要に関するセクションをご覧ください)。アプリケーションゲートウェイの正常性プローブは HTTP/HTTPS のみです。アプリケーションゲートウェイが WebSocket トラフィックをサーバーにルーティングするには、各バックエンドサーバーが HTTP プローブに応答する必要があります。

このプロトコルは、チャット、ダッシュボード、ゲームアプリなど、高速かつリアルタイムのコミュニケーションを活用するアプリで使用されます。

WebSocket のしくみ

WebSocket の接続を確立するために、特定の HTTP ベースのハンドシェイクがクライアントとサーバーの間で交換されます。成功すると、アプリケーションレイヤープロトコルは、以前に確立された TCP 接続を使用して、HTTP から WebSockets に "アップグレード" されます。これが発生すると、HTTP は完全に無関係になります。WebSocket 接続が閉じられるまで、両方のエンドポイントによって WebSocket プロトコルを使用してデータが送受信されます。

図では、Web サーバーとやりとりするクライアントを WebSocket のやりとりと比較しています。前者では 2 回接続し、2 つの応答を取得しますが、後者ではクライアントがサーバーに 1 回接続し、複数の応答を取得します。

Note

接続が WebSocket にアップグレードされると、Application Gateway では中間または終了プロキシとして、検査や操作機能なしで、フロントエンドから受信したデータをバックエンド (またはその逆) に送信します。そのため、Web アプリケーションファイアウォール (WAF) ではコンテンツを解析できず、そのようなデータに対して検査を実行しません。同様に、ヘッダーの書き換え、URL の書き換え、バックエンド設定でのホスト名のオーバーライドなどの操作は、WebSocket 接続を確立した後には適用されません。

リスナーの構成要素

既存の HTTP リスナーを使用して WebSocket トラフィックをサポートできます。サンプルテンプレートファイルの httpListeners 要素のスニペットを次に示します。 WebSocket トラフィックおよびセキュリティで保護された WebSocket トラフィックをサポートするには、HTTP リスナーと HTTPS リスナーの両方が必要です。同様に、ポータルまたは Azure PowerShell を使用して、ポート 80/443 にリスナーを設定したアプリケーションゲートウェイを作成して WebSocket トラフィックをサポートできます。

"httpListeners": [
        {
            "name": "appGatewayHttpsListener",
            "properties": {
                "FrontendIPConfiguration": {
                    "Id": "/subscriptions/{subscriptionId/resourceGroups/{resourceGroupName/providers/Microsoft.Network/applicationGateways/{applicationGatewayName/frontendIPConfigurations/DefaultFrontendPublicIP"
                },
                "FrontendPort": {
                    "Id": "/subscriptions/{subscriptionId/resourceGroups/{resourceGroupName/providers/Microsoft.Network/applicationGateways/{applicationGatewayName/frontendPorts/appGatewayFrontendPort443'"
                },
                "Protocol": "Https",
                "SslCertificate": {
                    "Id": "/subscriptions/{subscriptionId/resourceGroups/{resourceGroupName/providers/Microsoft.Network/applicationGateways/{applicationGatewayName/sslCertificates/appGatewaySslCert1'"
                },
            }
        },
        {
            "name": "appGatewayHttpListener",
            "properties": {
                "FrontendIPConfiguration": {
                    "Id": "/subscriptions/{subscriptionId/resourceGroups/{resourceGroupName/providers/Microsoft.Network/applicationGateways/{applicationGatewayName/frontendIPConfigurations/appGatewayFrontendIP'"
                },
                "FrontendPort": {
                    "Id": "/subscriptions/{subscriptionId/resourceGroups/{resourceGroupName/providers/Microsoft.Network/applicationGateways/{applicationGatewayName/frontendPorts/appGatewayFrontendPort80'"
                },
                "Protocol": "Http",
            }
        }
    ],

BackendAddressPool、BackendHttpSetting、およびルーティング規則の構成

WebSocket が有効なサーバーにバックエンドプールを定義するには、BackendAddressPool を使用します。 backendHttpSetting は、バックエンドポート 80 および 443 を使用して定義されます。 HTTP 設定の要求タイムアウト値は、WebSocket セッションにも適用されます。ルーティング規則を変更する必要はありません。それは、適切なリスナーを対応するバックエンドアドレスプールに関連付けるために使用されます。

"requestRoutingRules": [{
    "name": "<ruleName1>",
    "properties": {
        "RuleType": "Basic",
        "httpListener": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/httpListeners/appGatewayHttpsListener')]"
        },
        "backendAddressPool": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/ContosoServerPool')]"
        },
        "backendHttpSettings": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendHttpSettingsCollection/appGatewayBackendHttpSettings')]"
        }
    }

}, {
    "name": "<ruleName2>",
    "properties": {
        "RuleType": "Basic",
        "httpListener": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/httpListeners/appGatewayHttpListener')]"
        },
        "backendAddressPool": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/ContosoServerPool')]"
        },
        "backendHttpSettings": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendHttpSettingsCollection/appGatewayBackendHttpSettings')]"
        }

    }
}]

Note

クライアントから ping が送信される前にタイムアウトエラーが発生しないように、タイムアウト値がサーバーで定義された ping/pong 間隔よりも大きいことを確認します。 WebSocket の一般的な値は 20 秒であるため、たとえば、タイムアウト値を 40 秒に設定すると、クライアントが ping を送信する前にゲートウェイでタイムアウトエラーが送信されなくなります。そうしないと、クライアント側で 1006 エラーがスローされます。

WebSocket が有効なバックエンド

WebSocket が動作するためには、バックエンドの構成済みのポート (通常は 80/443) で HTTP/HTTPS Web サーバーが実行されている必要があります。この要件は、WebSocket プロトコルでは最初のハンドシェイクで HTTP を使用し、ヘッダーフィールドで WebSocket プロトコルへのアップグレードを指定する必要があるためです。ヘッダーの例を次に示します。

    GET /chat HTTP/1.1
    Host: server.example.com
    Upgrade: websocket
    Connection: Upgrade
    Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
    Origin: https://example.com
    Sec-WebSocket-Protocol: chat, superchat
    Sec-WebSocket-Version: 13

もう 1 つの理由としては、アプリケーションゲートウェイのバックエンドの正常性プローブでサポートされるプロトコルが HTTP と HTTPS のみであるという点が挙げられます。バックエンドサーバーが HTTP または HTTPS プローブに応答しない場合、そのバックエンドサーバーはバックエンドプールから取り除かれます。

次のステップ

WebSocket のサポートについて学習した後は、アプリケーションゲートウェイの作成に関するページに進んで、WebSocket が有効な Web アプリケーションを作成しましょう。

次の方法で共有