快速入門：使用 .NET 將事件傳送至 Azure 事件中樞並從中接收事件

將角色指派給 Microsoft Entra 使用者

在本機開發時，請確定連線到 Azure 事件中樞的使用者帳戶具有正確的權限。 您需要 Azure 事件中樞資料擁有者角色，才能傳送和接收訊息。 若要將此角色指派給您自己，您需要使用者存取管理員角色，或另一個包含 Microsoft.Authorization/roleAssignments/write 動作的角色。 您可以使用 Azure 入口網站、Azure CLI 或 Azure PowerShell，將 Azure RBAC 角色指派給使用者。 您可以在範圍概觀頁面上，深入了解角色指派的可用範圍。

下列範例會將 Azure Event Hubs Data Owner 角色指派給您的使用者帳戶，該角色提供對 Azure 事件中樞資源的完整存取權。 在實際案例中，遵循最低權限原則，只為使用者提供更安全實際執行環境所需的最低權限。

Azure 事件中樞的 Azure 內建角色

對於 Azure 事件中樞來說，透過 Azure 入口網站和 Azure 資源管理 API 來管理的命名空間和所有相關資源，皆已使用 Azure RBAC 模型來加以保護。 Azure 提供下列 Azure 內建角色，以授權存取事件中樞命名空間：

• Azure 事件中樞資料擁有者：允許資料存取事件中樞命名空間及其實體 (佇列、主題、訂用帳戶和篩選)
• Azure 事件中樞資料傳送者：使用此角色可讓傳送者存取事件中樞命名空間及其實體。
• Azure 事件中樞資料接收者：使用此角色可讓接收者存取事件中樞命名空間及其實體。

如果您想要建立自訂角色，請參閱事件中樞作業所需的權限。

az eventhubs namespace show -g '<your-event-hub-resource-group>' -n '<your-event-hub-name> --query id

az role assignment create --assignee "<user@domain>" \
--role "Azure Event Hubs Data Owner" \
--scope "<your-resource-id>"

Get-AzResource -ResourceGroupName "<your-event-hub-resource-group>" -Name "<your-event-hub-name>"

New-AzRoleAssignment -SignInName <user@domain> `
-RoleDefinitionName "Azure Event Hubs Data Owner" `
-Scope <yourResourceId>

啟動 Visual Studio 並登入 Azure

您可以使用下列步驟來授權存取服務匯流排命名空間：

1. 啟動 Visual Studio。 如果您看到 [開始使用] 視窗，請選取右窗格中的 [繼續但不開啟程式碼] 連結。

2. 選取 Visual Studio 右上方的 [登入] 按鈕。

   

3. 使用您先前指派角色的 Microsoft Entra 帳戶來登入。

   

取得連接字串

建立新命名空間時會自動產生初始共用存取簽章 (SAS) 原則，其中含有主要和次要金鑰以及連接字串，而每個都可授與命名空間所有層面的完整控制權。 請參閱事件中樞驗證與授權，以了解如何建立進一步的規則，對一般傳送者和接收者的權限施加更多限制。

用戶端可以使用連接字串來連線到事件中樞命名空間。 若要複製命名空間的主要連接字串，請遵循下列步驟：

1. 在 [事件中樞命名空間] 頁面中，選取左側功能表上的 [共用存取原則]。

2. 在 [共用存取原則] 頁面上，選取 [RootManageSharedAccessKey]。

3. 在 [原則：RootManageSharedAccessKey] 視窗中，選取在 [主要連接字串] 旁邊的複製按鈕，將連接字串複製到您的剪貼簿以供後續使用。 將此值貼到記事本或一些其他暫存位置。

   

   您可使用此頁面來複製主要金鑰、次要金鑰、主要連接字串和次要連接字串。

1. 從功能表選取 [工具]>[NuGet 套件管理員]>[套件管理員主控台]。

2. 執行下列命令來安裝 Azure.Messaging.EventHubs 和 Azure.Identity NuGet 套件。 按下 ENTER 鍵，執行第二個命令。

   Install-Package Azure.Messaging.EventHubs
   Install-Package Azure.Identity
   

1. 從功能表選取 [工具]>[NuGet 套件管理員]>[套件管理員主控台]。

2. 執行以下命令來安裝 Azure.Messaging.EventHubs NuGet 套件：

   Install-Package Azure.Messaging.EventHubs
   

1. 將 Program.cs 檔案中的現有程式碼取代為下列範例程序碼。 然後，將 EventHubProducerClient 參數的 <EVENT_HUB_NAMESPACE> 和 <HUB_NAME> 預留位置值，取代為事件中樞命名空間的名稱和事件中樞的名稱。 例如："spehubns0309.servicebus.windows.net" 和 "spehub"。

   以下是程式碼的重要步驟：

   1. 使用命名空間和事件中樞名稱建立 EventHubProducerClient 物件。
   2. 在 EventHubProducerClient 物件上叫用 CreateBatchAsync 方法，以建立 EventDataBatch 物件。
   3. 使用 EventDataBatch.TryAdd 方法將事件新增至批次。
   4. 使用 EventHubProducerClient.SendAsync 方法，將訊息的批次傳送至事件中樞。

   using Azure.Identity;
   using Azure.Messaging.EventHubs;
   using Azure.Messaging.EventHubs.Producer;
   using System.Text;
   
   // number of events to be sent to the event hub
   int numOfEvents = 3;
   
   // The Event Hubs client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when events are being published or read regularly.
   // TODO: Replace the <EVENT_HUB_NAMESPACE> and <HUB_NAME> placeholder values
   EventHubProducerClient producerClient = new EventHubProducerClient(
       "<EVENT_HUB_NAMESPACE>.servicebus.windows.net",
       "<HUB_NAME>",
       new DefaultAzureCredential());
   
   // Create a batch of events 
   using EventDataBatch eventBatch = await producerClient.CreateBatchAsync();
   
   for (int i = 1; i <= numOfEvents; i++)
   {
       if (!eventBatch.TryAdd(new EventData(Encoding.UTF8.GetBytes($"Event {i}"))))
       {
           // if it is too large for the batch
           throw new Exception($"Event {i} is too large for the batch and cannot be sent.");
       }
   }
   
   try
   {
       // Use the producer client to send the batch of events to the event hub
       await producerClient.SendAsync(eventBatch);
       Console.WriteLine($"A batch of {numOfEvents} events has been published.");
       Console.ReadLine();
   }
   finally
   {
       await producerClient.DisposeAsync();
   }
   

1. 將 Program.cs 檔案中的現有程式碼取代為下列範例程序碼。 然後，取代 EventHubProducerClient 參數的 <CONNECTION_STRING> 和 <HUB_NAME> 預留位置值。

   以下是程式碼的重要步驟：

   1. 使用命名空間和事件中樞名稱的主要連接字串，建立 EventHubProducerClient 物件。
   2. 叫用 EventHubProducerClient 物件上的 CreateBatchAsync 方法，以建立 EventDataBatch 物件。
   3. 使用 EventDataBatch.TryAdd 方法將事件新增至批次。
   4. 使用 EventHubProducerClient.SendAsync 方法，將訊息的批次傳送至事件中樞。

   using Azure.Messaging.EventHubs;
   using Azure.Messaging.EventHubs.Producer;
   using System.Text;
   
   // number of events to be sent to the event hub
   int numOfEvents = 3;
   
   // The Event Hubs client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when events are being published or read regularly.
   // TODO: Replace the <CONNECTION_STRING> and <HUB_NAME> placeholder values
   EventHubProducerClient producerClient = new EventHubProducerClient(
       "<CONNECTION_STRING>",
       "<HUB_NAME>");
   
   // Create a batch of events 
   using EventDataBatch eventBatch = await producerClient.CreateBatchAsync();
   
   for (int i = 1; i <= numOfEvents; i++)
   {
       if (!eventBatch.TryAdd(new EventData(Encoding.UTF8.GetBytes($"Event {i}"))))
       {
           // if it is too large for the batch
           throw new Exception($"Event {i} is too large for the batch and cannot be sent.");
       }
   }
   
   try
   {
       // Use the producer client to send the batch of events to the event hub
       await producerClient.SendAsync(eventBatch);
       Console.WriteLine($"A batch of {numOfEvents} events has been published.");
       Console.ReadLine();
   }
   finally
   {
       await producerClient.DisposeAsync();
   }
   

在本機開發時，請確定存取 Blob 資料的使用者帳戶具有正確的權限。 您需要儲存體 Blob 資料參與者才能讀取和寫入 Blob 資料。 若要指派此角色給您自己，您需要被指派使用者存取管理員角色，或另一個包含 Microsoft.Authorization/roleAssignments/write 動作的角色。 您可以使用 Azure 入口網站、Azure CLI 或 Azure PowerShell，將 Azure RBAC 角色指派給使用者。 您可以在範圍概觀頁面上深入了解角色指派的可用範圍。

在此案例中，您會將權限指派給使用者帳戶 (以儲存體帳戶為範圍)，以遵循最低權限原則。 此做法只為使用者提供所需的最低權限，並建立更安全的實際執行環境。

下列範例將儲存體 Blob 資料參與者角色指派給使用者帳戶，以針對儲存體帳戶中的 Blob 資料提供讀取和寫入存取權。

az storage account show --resource-group '<your-resource-group-name>' --name '<your-storage-account-name>' --query id

az role assignment create --assignee "<user@domain>" \
    --role "Storage Blob Data Contributor" \
    --scope "<your-resource-id>"

Get-AzResource -ResourceGroupName "<yourResourceGroupname>" -Name "<yourStorageAccountName>"

New-AzRoleAssignment -SignInName <user@domain> `
    -RoleDefinitionName "Storage Blob Data Contributor" `
    -Scope <yourStorageAccountId>

取得儲存體帳戶的連接字串

記下連接字串和容器名稱。 您可以在程式代碼中使用它們，從事件中樞接收事件。

1. 從功能表選取 [工具]>[NuGet 套件管理員]>[套件管理員主控台]。

2. 在 [套件管理員主控台] 視窗中，確認已針對 [預設專案] 選取 [EventHubsReceiver]。 如果不是，請使用下拉式清單選取 [EventHubsReceiver]。

3. 執行下列命令以安裝 Azure.Messaging.EventHubs 和 Azure.Identity NuGet 套件。 按下 ENTER 鍵，執行最後一個命令。

   Install-Package Azure.Messaging.EventHubs
   Install-Package Azure.Messaging.EventHubs.Processor
   Install-Package Azure.Identity
   

1. 從功能表選取 [工具]>[NuGet 套件管理員]>[套件管理員主控台]。

2. 在 [套件管理員主控台] 視窗中，確認已針對 [預設專案] 選取 [EventHubsReceiver]。 如果不是，請使用下拉式清單選取 [EventHubsReceiver]。

3. 執行以下命令來安裝 Azure.Messaging.EventHubs NuGet 套件：

   Install-Package Azure.Messaging.EventHubs
   Install-Package Azure.Messaging.EventHubs.Processor
   

1. 將 Program.cs 檔案中的現有程式碼取代為下列範例程序碼。 然後，取代 BlobContainerClient URI 的 <STORAGE_ACCOUNT_NAME> 和 <BLOB_CONTAINER_NAME> 預留位置值。 也取代 EventProcessorClient 的 <EVENT_HUB_NAMESPACE> 和 <HUB_NAME> 預留位置值。

   以下是程式碼的重要步驟：

   1. 使用事件中樞命名空間和事件中樞名稱，建立 EventProcessorClient 物件。 您必須針對您稍早所建立 Azure 儲存體中的容器來建置 BlobContainerClient 物件。
   2. 指定 EventProcessorClient 物件的 ProcessEventAsync 和 ProcessErrorAsync 事件的處理常式。
   3. 在 EventProcessorClient 物件上叫用 StartProcessingAsync 以開始處理事件。
   4. 在 EventProcessorClient 物件上叫用 StopProcessingAsync，以在 30 秒後停止處理事件。

   using Azure.Identity;
   using Azure.Messaging.EventHubs;
   using Azure.Messaging.EventHubs.Consumer;
   using Azure.Messaging.EventHubs.Processor;
   using Azure.Storage.Blobs;
   using System.Text;
   
   // Create a blob container client that the event processor will use
   // TODO: Replace <STORAGE_ACCOUNT_NAME> and <BLOB_CONTAINER_NAME> with actual names
   BlobContainerClient storageClient = new BlobContainerClient(
       new Uri("https://<STORAGE_ACCOUNT_NAME>.blob.core.windows.net/<BLOB_CONTAINER_NAME>"),
       new DefaultAzureCredential());
   
   // Create an event processor client to process events in the event hub
   // TODO: Replace the <EVENT_HUBS_NAMESPACE> and <HUB_NAME> placeholder values
   var processor = new EventProcessorClient(
       storageClient,
       EventHubConsumerClient.DefaultConsumerGroupName,
       "<EVENT_HUB_NAMESPACE>.servicebus.windows.net",
       "<HUB_NAME>",
       new DefaultAzureCredential());
   
   // Register handlers for processing events and handling errors
   processor.ProcessEventAsync += ProcessEventHandler;
   processor.ProcessErrorAsync += ProcessErrorHandler;
   
   // Start the processing
   await processor.StartProcessingAsync();
   
   // Wait for 30 seconds for the events to be processed
   await Task.Delay(TimeSpan.FromSeconds(30));
   
   // Stop the processing
   await processor.StopProcessingAsync();
   
   Task ProcessEventHandler(ProcessEventArgs eventArgs)
   {
       // Write the body of the event to the console window
       Console.WriteLine("\tReceived event: {0}", Encoding.UTF8.GetString(eventArgs.Data.Body.ToArray()));
       Console.ReadLine();
       return Task.CompletedTask;
   }
   
   Task ProcessErrorHandler(ProcessErrorEventArgs eventArgs)
   {
       // Write details about the error to the console window
       Console.WriteLine($"\tPartition '{eventArgs.PartitionId}': an unhandled exception was encountered. This was not expected to happen.");
       Console.WriteLine(eventArgs.Exception.Message);
       Console.ReadLine();
       return Task.CompletedTask;
   }
   

1. 將 Program.cs 檔案中的現有程式碼取代為下列範例程序碼。 然後，取代 BlobContainerClient URI 的 <AZURE_STORAGE_CONNECTION_STRING> 和 <BLOB_CONTAINER_NAME> 預留位置值。 也取代 EventProcessorClient 的 <EVENT_HUB_NAMESPACE_CONNECTION_STRING> 和 <HUB_NAME> 預留位置值。

   以下是程式碼的重要步驟：

   1. 使用命名空間和事件中樞的主要連接字串，建立 EventProcessorClient 物件。 您必須針對您稍早所建立 Azure 儲存體中的容器來建置 BlobContainerClient 物件。
   2. 指定 EventProcessorClient 物件的 ProcessEventAsync 和 ProcessErrorAsync 事件的處理常式。
   3. 在 EventProcessorClient 物件上叫用 StartProcessingAsync 以開始處理事件。
   4. 在 EventProcessorClient 物件上叫用 StopProcessingAsync，以在 30 秒後停止處理事件。

   using Azure.Messaging.EventHubs;
   using Azure.Messaging.EventHubs.Consumer;
   using Azure.Messaging.EventHubs.Processor;
   using Azure.Storage.Blobs;
   using System.Text;
   
   // Create a blob container client that the event processor will use 
   BlobContainerClient storageClient = new BlobContainerClient(
       "<AZURE_STORAGE_CONNECTION_STRING>", "<BLOB_CONTAINER_NAME>");
   
   // Create an event processor client to process events in the event hub
   var processor = new EventProcessorClient(
       storageClient,
       EventHubConsumerClient.DefaultConsumerGroupName,
       "<EVENT_HUBS_NAMESPACE_CONNECTION_STRING>",
       "<HUB_NAME>");
   
   // Register handlers for processing events and handling errors
   processor.ProcessEventAsync += ProcessEventHandler;
   processor.ProcessErrorAsync += ProcessErrorHandler;
   
   // Start the processing
   await processor.StartProcessingAsync();
   
   // Wait for 30 seconds for the events to be processed
   await Task.Delay(TimeSpan.FromSeconds(30));
   
   // Stop the processing
   await processor.StopProcessingAsync();
   
   Task ProcessEventHandler(ProcessEventArgs eventArgs)
   {
       // Write the body of the event to the console window
       Console.WriteLine("\tReceived event: {0}", Encoding.UTF8.GetString(eventArgs.Data.Body.ToArray()));
       return Task.CompletedTask;
   }
   
   Task ProcessErrorHandler(ProcessErrorEventArgs eventArgs)
   {
       // Write details about the error to the console window
       Console.WriteLine($"\tPartition '{eventArgs.PartitionId}': an unhandled exception was encountered. This was not expected to happen.");
       Console.WriteLine(eventArgs.Exception.Message);
       return Task.CompletedTask;
   }