Schnellstart: Senden von Ereignissen an und Empfangen von Ereignissen aus Azure Event Hubs mithilfe von .NET

Zuweisen von Rollen zu Ihrem Microsoft Entra-Benutzer

Achten Sie bei der lokalen Entwicklung darauf, dass das Benutzerkonto, das die Verbindung mit Azure Event Hubs herstellt, über die korrekten Berechtigungen verfügt. Zum Senden und Empfangen von Nachrichten ist die Rolle Azure Event Hubs-Datenbesitzer erforderlich. Um sich selbst diese Rolle zuweisen zu können, benötigen Sie die Rolle „Benutzerzugriffsadministrator“ oder eine andere Rolle, die die Aktion Microsoft.Authorization/roleAssignments/write umfasst. Sie können einem Benutzer Azure RBAC-Rollen über das Azure-Portal, die Azure CLI oder mit Azure PowerShell zuweisen. Weitere Informationen zu den verfügbaren Bereichen für Rollenzuweisungen finden Sie auf der Seite Grundlegendes zum Bereich von Azure RBAC.

Im folgenden Beispiel wird Ihrem Benutzerkonto die Rolle Azure Event Hubs Data Owner zugewiesen. Diese Rolle bietet Vollzugriff auf Azure Event Hubs-Ressourcen. Halten Sie sich in einem echten Szenario an das Prinzip der geringsten Rechte, um Benutzern nur die benötigten Mindestberechtigungen zu erteilen und so die Produktionsumgebung besser zu schützen.

In Azure integrierte Rollen für Azure Event Hubs

Bei Azure Event Hubs ist die Verwaltung der Namespaces und aller zugehörigen Ressourcen über das Azure-Portal und die Azure-Ressourcenverwaltungs-API bereits durch das Azure RBAC-Modell geschützt. Azure stellt die folgenden integrierten Azure-Rollen zum Autorisieren des Zugriffs auf einen Event Hubs-Namespace bereit:

• Azure Event Hubs-Datenbesitzer: Ermöglicht den Datenzugriff auf einen Event Hubs-Namespace und seine Entitäten (Warteschlangen, Themen, Abonnements und Filter).
• Azure Event Hubs-Datensender: Verwenden Sie diese Rolle, um dem Event Hubs-Namespace und seinen Entitäten Sendezugriff zu erteilen.
• Azure Event Hubs-Datenempfänger: Verwenden Sie diese Rolle, um dem Event Hubs-Namespace und seinen Entitäten Empfangszugriff zu erteilen.

Informationen zum Erstellen einer benutzerdefinierten Rolle finden Sie unter Erforderliche Rechte für Event Hubs-Vorgänge.

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>

Starten von Visual Studio und Anmelden bei Azure

Der Zugriff auf den Service Bus-Namespace kann mithilfe der folgenden Schritte autorisiert werden:

1. Starten Sie Visual Studio. Wenn das Fenster Erste Schritte angezeigt wird, wählen Sie im rechten Bereich den Link Ohne Code fortfahren aus.

2. Wählen Sie oben rechts in Visual Studio die Schaltfläche Anmelden aus.

   

3. Melden Sie sich mit dem Microsoft Entra-Konto an, dem Sie zuvor eine Rolle zugewiesen haben.

   

Abrufen der Verbindungszeichenfolge

Beim Erstellen eines neuen Namespace wird automatisch eine anfängliche SAS-Richtlinie (Shared Access Signature) mit primären und sekundären Schlüsseln und Verbindungszeichenfolgen generiert, mit denen Sie jeweils die vollständige Kontrolle über sämtliche Aspekte des Namespace haben. Unter Event Hubs-Authentifizierung und -Autorisierung erfahren Sie, wie Sie Regeln mit stärker eingeschränkten Rechten für reguläre Sender und Empfänger erstellen.

Ein Client kann die Verbindungszeichenfolge verwenden, um eine Verbindung mit dem Event Hubs-Namespace herzustellen. Führen Sie die folgenden Schritte aus, um die primäre Verbindungszeichenfolge für Ihren Namespace zu kopieren:

1. Wählen Sie auf der Seite Event Hubs-Namespace im linken Menü die Option Freigegebene Zugriffsrichtlinien aus.

2. Wählen Sie auf der Seite Freigegebene Zugriffsrichtlinien die Option RootManageSharedAccessKey aus.

3. Wählen Sie im Fenster Richtlinie: RootManageSharedAccessKey neben Primäre Verbindungszeichenfolge die Schaltfläche „Kopieren“ aus, um die Verbindungszeichenfolge zur späteren Verwendung in die Zwischenablage zu kopieren. Fügen Sie diesen Wert in den Editor oder an einem anderen temporären Speicherort ein.

   

   Auf dieser Seite können Sie den Primärschlüssel, den sekundären Schlüssel, die primäre Verbindungszeichenfolge und die sekundäre Verbindungszeichenfolge kopieren.

1. Wählen Sie im Menü Extras>NuGet-Paket-Manager>Paket-Manager-Konsole aus.

2. Führen Sie den folgenden Befehl aus, um die NuGet-Pakete Azure.Messaging.EventHubs und Azure.Identity zu installieren. Drücken Sie die EINGABETASTE, um den zweiten Befehl auszuführen.

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

1. Wählen Sie im Menü Extras>NuGet-Paket-Manager>Paket-Manager-Konsole aus.

2. Führen Sie den folgenden Befehl aus, um das NuGet-Paket Azure.Messaging.EventHubs zu installieren:

   Install-Package Azure.Messaging.EventHubs
   

1. Ersetzen Sie den vorhandenen Code in der Datei Program.cs durch den folgenden Beispielcode. Ersetzen Sie dann die Platzhalterwerte <EVENT_HUB_NAMESPACE> und <HUB_NAME> für die EventHubProducerClient-Parameter durch die Namen Ihres Event Hubs-Namespaces und des Event Hubs. Beispiel: "spehubns0309.servicebus.windows.net" und "spehub".

   Hier sind die wesentlichen Schritte aus dem Code aufgeführt:

   1. Es wird ein EventHubProducerClient-Objekt unter Verwendung des Namespace und des Event Hub-Namens erstellt.
   2. Die Methode CreateBatchAsync für das Objekt EventHubProducerClient wird aufgerufen, um ein EventDataBatch-Objekt zu erstellen.
   3. Dem Batch werden mithilfe der Methode EventDataBatch.TryAdd Ereignisse hinzugefügt.
   4. Der Nachrichtenbatch wird mithilfe der EventHubProducerClient.SendAsync-Methode an den Event Hub gesendet.

   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. Ersetzen Sie den vorhandenen Code in der Datei Program.cs durch den folgenden Beispielcode. Ersetzen Sie dann die Platzhalterwerte <CONNECTION_STRING> und <HUB_NAME> für den EventHubProducerClient-Parameter.

   Hier sind die wesentlichen Schritte aus dem Code aufgeführt:

   1. Es wird ein EventHubProducerClient-Objekt unter Verwendung der primären Verbindungszeichenfolge für den Namespace und den Event Hub-Namen erstellt.
   2. Die Methode CreateBatchAsync für das Objekt EventHubProducerClient wird aufgerufen, um ein EventDataBatch-Objekt zu erstellen.
   3. Dem Batch werden mithilfe der Methode EventDataBatch.TryAdd Ereignisse hinzugefügt.
   4. Der Nachrichtenbatch wird mithilfe der EventHubProducerClient.SendAsync-Methode an den Event Hub gesendet.

   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();
   }
   

Stellen Sie beim lokalen Entwickeln sicher, dass das Benutzerkonto, das auf Blobdaten zugreift, die richtigen Berechtigungen hat. Sie benötigen die Berechtigung Mitwirkender an Storage-Blobdaten zum Lesen und Schreiben von Blobdaten. Um sich selbst diese Rolle zuweisen zu können, benötigen Sie die Rolle Benutzerzugriffsadministrator oder eine andere Rolle, die die Aktion Microsoft.Authorization/roleAssignments/write enthält. Sie können einem Benutzer Azure RBAC-Rollen über das Azure-Portal, die Azure CLI oder mit Azure PowerShell zuweisen. Weitere Informationen zu den verfügbaren Bereichen für Rollenzuweisungen finden Sie auf der Seite Bereichsübersicht.

In diesem Szenario weisen Sie Ihrem Benutzerkonto Berechtigungen zu, die auf das Speicherkonto zugeschnitten sind, um dem Prinzip der geringsten Rechte zu folgen. Auf diese Weise erhalten Benutzer nur die erforderlichen Mindestberechtigungen, und es entstehen sicherere Produktionsumgebungen.

Im folgenden Beispiel wird Ihrem Benutzerkonto die Rolle Mitwirkender an Storage-Blobdaten zugewiesen, die sowohl Lese- als auch Schreibzugriff auf Blobdaten in Ihrem Speicherkonto ermöglicht.

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>

Abrufen der Verbindungszeichenfolge für das Speicherkonto

Notieren Sie sich die Verbindungszeichenfolge und den Containernamen. Sie verwenden sie im Code, um Ereignisse vom Event Hub zu empfangen.

1. Wählen Sie im Menü Extras>NuGet-Paket-Manager>Paket-Manager-Konsole aus.

2. Bestätigen Sie im Fenster Paket-Manager-Konsole, dass EventHubsReceiver als Standardprojekt ausgewählt wurde. Ist dies nicht der Fall, wählen Sie in der Dropdownliste EventHubsReceiver aus.

3. Führen Sie den folgenden Befehl aus, um die NuGet-Pakete Azure.Messaging.EventHubs und Azure.Identity zu installieren. Drücken Sie die EINGABETASTE, um den letzten Befehl auszuführen.

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

1. Wählen Sie im Menü Extras>NuGet-Paket-Manager>Paket-Manager-Konsole aus.

2. Bestätigen Sie im Fenster Paket-Manager-Konsole, dass EventHubsReceiver als Standardprojekt ausgewählt wurde. Ist dies nicht der Fall, wählen Sie in der Dropdownliste EventHubsReceiver aus.

3. Führen Sie den folgenden Befehl aus, um das NuGet-Paket Azure.Messaging.EventHubs zu installieren:

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

1. Ersetzen Sie den vorhandenen Code in der Datei Program.cs durch den folgenden Beispielcode. Ersetzen Sie dann die Platzhalterwerte <STORAGE_ACCOUNT_NAME> und <BLOB_CONTAINER_NAME> für den BlobContainerClient-URI. Ersetzen Sie auch die <EVENT_HUB_NAMESPACE>- und <HUB_NAME>-Platzhalterwerte für den EventProcessorClient.

   Hier sind die wesentlichen Schritte aus dem Code aufgeführt:

   1. Erstellt ein EventProcessorClient-Objekt mit dem Event Hubs-Namespace und dem Event Hub-Namen. Sie müssen das BlobContainerClient-Objekt für den Container im Azure-Speicher erstellen, den Sie zuvor erstellt haben.
   2. Es werden Handler für die Ereignisse ProcessEventAsync und ProcessErrorAsync des Objekts EventProcessorClient angegeben.
   3. Die Verarbeitung von Ereignissen wird gestartet, indem die Funktion StartProcessingAsync für das Objekt EventProcessorClient aufgerufen wird.
   4. Beendet die Verarbeitung von Ereignissen nach 30 Sekunden durch Aufrufen von StopProcessingAsync für das EventProcessorClient-Objekt.

   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. Ersetzen Sie den vorhandenen Code in der Datei Program.cs durch den folgenden Beispielcode. Ersetzen Sie dann die Platzhalterwerte <AZURE_STORAGE_CONNECTION_STRING> und <BLOB_CONTAINER_NAME> für den BlobContainerClient-URI. Ersetzen Sie auch die <EVENT_HUB_NAMESPACE_CONNECTION_STRING>- und <HUB_NAME>-Platzhalterwerte für den EventProcessorClient.

   Hier sind die wesentlichen Schritte aus dem Code aufgeführt:

   1. Es wird ein EventProcessorClient-Objekt unter Verwendung der primären Verbindungszeichenfolge für den Namespace und den Event Hub erstellt. Sie müssen das BlobContainerClient-Objekt für den Container im Azure-Speicher erstellen, den Sie zuvor erstellt haben.
   2. Es werden Handler für die Ereignisse ProcessEventAsync und ProcessErrorAsync des Objekts EventProcessorClient angegeben.
   3. Die Verarbeitung von Ereignissen wird gestartet, indem die Funktion StartProcessingAsync für das Objekt EventProcessorClient aufgerufen wird.
   4. Beendet die Verarbeitung von Ereignissen nach 30 Sekunden durch Aufrufen von StopProcessingAsync für das EventProcessorClient-Objekt.

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