チュートリアル: .NET での Relay ハイブリッド接続 HTTP 要求の概要

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

NET
Node.js

このクイックスタートでは、HTTP プロトコルを使用してメッセージを送受信する .NET のセンダーアプリケーションとレシーバーアプリケーションを作成します。これらのアプリケーションには、Azure Relay のハイブリッド接続機能が使用されます。 Azure Relay 全般については、Azure Relay に関するページを参照してください。

このクイックスタートでは、以下の手順を実行します。

Azure Portal を使用した Relay 名前空間の作成
Azure Portal を使用した、その名前空間内のハイブリッド接続の作成
メッセージを受信するサーバー (リスナー) コンソールアプリケーションの作成
メッセージを送信するクライアント (送信側) コンソールアプリケーションの作成
アプリケーションの実行

前提条件

このチュートリアルを完了するには、次の前提条件を用意しておく必要があります。

Visual Studio 2019 以降。このチュートリアルの例では、Visual Studio 2022 を使用します。
Azure サブスクリプション。お持ちでない場合は、開始する前に無料アカウントを作成してください。

名前空間の作成

Azure portal にサインインします。
左側のメニューから、 [すべてのサービス] を選択します。 [統合] を選択し、[リレー] を検索し、[リレー] の上にマウスポインターを移動して、[作成] を選択します。
[名前空間の作成] ページで、これらの手順を実行します。
1. 名前空間を作成する Azure サブスクリプションを選択します。
2. [リソースグループ] で、名前空間を追加する既存のリソースグループを選択するか、新しいリソースグループを作成します。
3. リレー名前空間の名前を入力します。
4. 名前空間をホストするリージョンを選択します。
5. ページ下部にある [確認と作成] を選択します。
6. [確認および作成] ページで、 [作成] を選択します。
7. 数分後に、名前空間の [リレー] ページを確認します。

管理資格情報を取得する

[リレー] ページで、左側のメニューの [共有アクセスポリシー] を選択します。
[共有アクセスポリシー] ページで、 [RootManageSharedAccessKey] を選択します。
[SAS ポリシー:RootManageSharedAccessKey] の下で、 [プライマリ接続文字列] の横の [コピー] ボタンを選択します。これで、後で使用できるように接続文字列がクリップボードにコピーされます。この値をメモ帳などに一時的に貼り付けます。
前の手順を繰り返し、 [主キー] の値をコピーして、後で使用するために一時的な場所に貼り付けます。

ハイブリッド接続の追加

名前空間の [リレー] ページで、次の手順に従ってハイブリッド接続を作成します。

左側のメニューの [エンティティ] の下で、[ハイブリッド接続] を選択し、[+ ハイブリッド接続] を選択します。
[ハイブリッド接続の作成] ページで、ハイブリッド接続の名前を入力し、[作成] を選択します。

サーバーアプリケーション (リスナー) の作成

Visual Studio で C# コンソールアプリケーションを作成して、Relay からのメッセージをリッスンおよび受信します。

コンソールアプリケーションを作成する

Visual Studio で、新しいコンソールアプリ (.NET Framework) プロジェクトを作成します。

Relay NuGet パッケージを追加する

新しく作成したプロジェクトを右クリックしてから、[NuGet パッケージの管理] を選択します。
[参照] を選択し、Microsoft.Azure.Relay を検索します。検索結果から、"Microsoft Azure Relay" を選択します。
[インストール] を選択してインストールを完了します。ダイアログボックスを閉じる

メッセージを受信するコードを記述する

Program.cs ファイルの先頭にある既存の using ステートメントを、次の using ステートメントに置き換えます。
```
using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Azure.Relay;
using System.Net;
```

ハイブリッド接続の詳細に関する定数を Program クラスに追加します。中かっこ内のプレースホルダーを、ハイブリッド接続の作成時に取得した値に置き換えます。必ず完全修飾名前空間名を使用してください。

// replace {RelayNamespace} with the name of your namespace
private const string RelayNamespace = "{RelayNamespace}.servicebus.windows.net";

// replace {HybridConnectionName} with the name of your hybrid connection
private const string ConnectionName = "{HybridConnectionName}";

// replace {SAKKeyName} with the name of your Shared Access Policies key, which is RootManageSharedAccessKey by default
private const string KeyName = "{SASKeyName}";

// replace {SASKey} with the primary key of the namespace you saved earlier
private const string Key = "{SASKey}";

RunAsync メソッドを Program クラスに追加します。

private static async Task RunAsync()
{
    var cts = new CancellationTokenSource();

    var tokenProvider = TokenProvider.CreateSharedAccessSignatureTokenProvider(KeyName, Key);
    var listener = new HybridConnectionListener(new Uri(string.Format("sb://{0}/{1}", RelayNamespace, ConnectionName)), tokenProvider);

    // Subscribe to the status events.
    listener.Connecting += (o, e) => { Console.WriteLine("Connecting"); };
    listener.Offline += (o, e) => { Console.WriteLine("Offline"); };
    listener.Online += (o, e) => { Console.WriteLine("Online"); };

    // Provide an HTTP request handler
    listener.RequestHandler = (context) =>
    {
        // Do something with context.Request.Url, HttpMethod, Headers, InputStream...
        context.Response.StatusCode = HttpStatusCode.OK;
        context.Response.StatusDescription = "OK, This is pretty neat";
        using (var sw = new StreamWriter(context.Response.OutputStream))
        {
            sw.WriteLine("hello!");
        }

        // The context MUST be closed here
        context.Response.Close();
    };

    // Opening the listener establishes the control channel to
    // the Azure Relay service. The control channel is continuously 
    // maintained, and is reestablished when connectivity is disrupted.
    await listener.OpenAsync();
    Console.WriteLine("Server listening");

    // Start a new thread that will continuously read the console.
    await Console.In.ReadLineAsync();

    // Close the listener after you exit the processing loop.
    await listener.CloseAsync();
}

Program クラスの Main メソッドに次のコード行を追加します。

RunAsync().GetAwaiter().GetResult();

完成した Program.cs ファイルは次のようになります。

namespace Server
{
    using System;
    using System.IO;
    using System.Threading;
    using System.Threading.Tasks;
    using Microsoft.Azure.Relay;
    using System.Net;

    public class Program
    {
        private const string RelayNamespace = "{RelayNamespace}.servicebus.windows.net";
        private const string ConnectionName = "{HybridConnectionName}";
        private const string KeyName = "{SASKeyName}";
        private const string Key = "{SASKey}";

        public static void Main(string[] args)
        {
            RunAsync().GetAwaiter().GetResult();
        }

        private static async Task RunAsync()
        {
            var tokenProvider = TokenProvider.CreateSharedAccessSignatureTokenProvider(KeyName, Key);
            var listener = new HybridConnectionListener(new Uri(string.Format("sb://{0}/{1}", RelayNamespace, ConnectionName)), tokenProvider);

            // Subscribe to the status events.
            listener.Connecting += (o, e) => { Console.WriteLine("Connecting"); };
            listener.Offline += (o, e) => { Console.WriteLine("Offline"); };
            listener.Online += (o, e) => { Console.WriteLine("Online"); };

            // Provide an HTTP request handler
            listener.RequestHandler = (context) =>
            {
                // Do something with context.Request.Url, HttpMethod, Headers, InputStream...
                context.Response.StatusCode = HttpStatusCode.OK;
                context.Response.StatusDescription = "OK";
                using (var sw = new StreamWriter(context.Response.OutputStream))
                {
                    sw.WriteLine("hello!");
                }

                // The context MUST be closed here
                context.Response.Close();
            };

            // Opening the listener establishes the control channel to
            // the Azure Relay service. The control channel is continuously 
            // maintained, and is reestablished when connectivity is disrupted.
            await listener.OpenAsync();
            Console.WriteLine("Server listening");

            // Start a new thread that will continuously read the console.
            await Console.In.ReadLineAsync();

            // Close the listener after you exit the processing loop.
            await listener.CloseAsync();
        }
    }
}

クライアントアプリケーション (センダー) の作成

Visual Studio で C# コンソールアプリケーションを作成して、Relay にメッセージを送信します。

コンソールアプリケーションを作成する

リレーの作成時に [クライアント認証が必要] オプションを無効にしていた場合には、ブラウザーを問わずハイブリッド接続 URL に要求を送信できます。保護されているエンドポイントにアクセスするには、ここに示したように ServiceBusAuthorization ヘッダーでトークンを作成して渡す必要があります。

Visual Studio で、新しいコンソールアプリ (.NET Framework) プロジェクトを作成します。

Relay NuGet パッケージを追加する

新しく作成したプロジェクトを右クリックしてから、[NuGet パッケージの管理] を選択します。
[プレリリースを含める] オプションを選択します。
[参照] を選択し、Microsoft.Azure.Relay を検索します。検索結果から、"Microsoft Azure Relay" を選択します。
[インストール] を選択してインストールを完了します。ダイアログボックスを閉じる

要求を送信するコードを記述する

Program.cs ファイルの先頭にある既存の using ステートメントを、次の using ステートメントに置き換えます。

using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
using System.Net.Http;
using Microsoft.Azure.Relay;

// replace {RelayNamespace} with the name of your namespace
private const string RelayNamespace = "{RelayNamespace}.servicebus.windows.net";

// replace {HybridConnectionName} with the name of your hybrid connection
private const string ConnectionName = "{HybridConnectionName}";

// replace {SAKKeyName} with the name of your Shared Access Policies key, which is RootManageSharedAccessKey by default
private const string KeyName = "{SASKeyName}";

// replace {SASKey} with the primary key of the namespace you saved earlier
private const string Key = "{SASKey}";

次のメソッドを Program クラスに追加します:

private static async Task RunAsync()
{
    var tokenProvider = TokenProvider.CreateSharedAccessSignatureTokenProvider(
            KeyName, Key);
    var uri = new Uri(string.Format("https://{0}/{1}", RelayNamespace, ConnectionName));
    var token = (await tokenProvider.GetTokenAsync(uri.AbsoluteUri, TimeSpan.FromHours(1))).TokenString;
    var client = new HttpClient();
    var request = new HttpRequestMessage()
    {
        RequestUri = uri,
        Method = HttpMethod.Get,
    };
    request.Headers.Add("ServiceBusAuthorization", token);
    var response = await client.SendAsync(request);
    Console.WriteLine(await response.Content.ReadAsStringAsync());        Console.ReadLine();
}

Program クラスの Main メソッドに次のコード行を追加します。

RunAsync().GetAwaiter().GetResult();

Program.cs は次のようになります。

using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
using System.Net.Http;
using Microsoft.Azure.Relay;

namespace Client
{
    class Program
    {
        private const string RelayNamespace = "{RelayNamespace}.servicebus.windows.net";
        private const string ConnectionName = "{HybridConnectionName}";
        private const string KeyName = "{SASKeyName}";
        private const string Key = "{SASKey}";

        static void Main(string[] args)
        {
            RunAsync().GetAwaiter().GetResult();
        }

        private static async Task RunAsync()
        {
           var tokenProvider = TokenProvider.CreateSharedAccessSignatureTokenProvider(
            KeyName, Key);
            var uri = new Uri(string.Format("https://{0}/{1}", RelayNamespace, ConnectionName));
            var token = (await tokenProvider.GetTokenAsync(uri.AbsoluteUri, TimeSpan.FromHours(1))).TokenString;
            var client = new HttpClient();
            var request = new HttpRequestMessage()
            {
                RequestUri = uri,
                Method = HttpMethod.Get,
            };
            request.Headers.Add("ServiceBusAuthorization", token);
            var response = await client.SendAsync(request);
            Console.WriteLine(await response.Content.ReadAsStringAsync());
        }
    }
}

Note

この記事のサンプルコードでは、接続文字列を使用して Azure Relay 名前空間に対する認証を行うことで、チュートリアルを簡素化します。運用環境では、接続文字列や共有アクセス署名ではなく、Microsoft Entra ID 認証を使用することをお勧めします。前者では、セキュリティ侵害の可能性が高まる場合があります。 Microsoft Entra ID 認証を使用するための詳細な情報とサンプルコードについては、「Azure Relay エンティティにアクセスするための Microsoft Entra ID を使用したアプリケーションの認証と承認」および、「Azure Relay リソースにアクセスするための Microsoft Entra ID でのマネージド ID の認証」を参照してください。

アプリケーションの実行

サーバーアプリケーションを実行します。コンソールウィンドウに次のテキストが表示されます。
```
Online
Server listening
```
クライアントアプリケーションを実行します。クライアントウィンドウに hello! が表示されます。クライアントは HTTP 要求をサーバーに送信し、サーバーは hello! で応答しました。
ここで、コンソールウィンドウを閉じるには、両方のコンソールウィンドウで Enter キーを押します。

このクイックスタートでは、HTTP を使用してメッセージを送受信する .NET のクライアントアプリケーションとサーバーアプリケーションを作成しました。 Azure Relay のハイブリッド接続機能は、WebSocket を使用したメッセージの送受信もサポートしています。 Azure Relay のハイブリッド接続で WebSocket を使用する方法については、WebSocket のクイックスタートを参照してください。

このクイックスタートでは、.NET Framework を使用してクライアントアプリケーションとサーバーアプリケーションを作成しました。 Node.js を使用してクライアントアプリケーションとサーバーアプリケーションを作成する方法については、Node.js WebSocket のクイックスタートまたは Node.js HTTP のクイックスタートを参照してください。

次の方法で共有

チュートリアル: .NET での Relay ハイブリッド接続 HTTP 要求の概要

前提条件

名前空間の作成

管理資格情報を取得する

ハイブリッド接続の追加

サーバーアプリケーション (リスナー) の作成

コンソールアプリケーションを作成する

Relay NuGet パッケージを追加する

メッセージを受信するコードを記述する

クライアントアプリケーション (センダー) の作成

コンソールアプリケーションを作成する

Relay NuGet パッケージを追加する

要求を送信するコードを記述する

アプリケーションの実行

フィードバック

その他のリソース

次の方法で共有

チュートリアル: .NET での Relay ハイブリッド接続 HTTP 要求の概要

前提条件

名前空間の作成

管理資格情報を取得する

ハイブリッド接続の追加

サーバー アプリケーション (リスナー) の作成

コンソール アプリケーションを作成する

Relay NuGet パッケージを追加する

メッセージを受信するコードを記述する

クライアント アプリケーション (センダー) の作成

コンソール アプリケーションを作成する

Relay NuGet パッケージを追加する

要求を送信するコードを記述する

アプリケーションの実行

関連するコンテンツ

フィードバック

その他のリソース

サーバーアプリケーション (リスナー) の作成

コンソールアプリケーションを作成する

クライアントアプリケーション (センダー) の作成

コンソールアプリケーションを作成する