Краткое руководство. Отправка событий в Центры событий Azure и получение событий с помощью .NET

Назначение ролей пользователю Microsoft Entra

При локальной разработке убедитесь, что учетная запись пользователя, которая подключается к Центры событий Azure имеет правильные разрешения. Для отправки и получения сообщений вам потребуется роль владельца данных Azure Event Hubs. Чтобы назначить себе эту роль, вам потребуется роль администратора доступа пользователей или другая роль, которая включает Microsoft.Authorization/roleAssignments/write действие. Роли Azure RBAC можно назначить пользователю с помощью портала Azure, Azure CLI или Azure PowerShell. Дополнительные сведения о доступных границах назначения ролей см. на странице обзора границ.

В следующем примере вашей учетной записи пользователя назначается роль Azure Event Hubs Data Owner, предоставляющая полный доступ к ресурсам Azure Event Hubs. В реальном сценарии следуйте принципу наименьших привилегий , чтобы предоставить пользователям только минимальные разрешения, необходимые для более безопасной рабочей среды.

Встроенные роли Azure для Центров событий Azure

Для Azure Event Hubs управление пространствами имен и всеми связанными ресурсами через портал Azure и API управления ресурсами Azure уже защищено с помощью модели 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. Нажмите клавишу ВВОД , чтобы выполнить вторую команду.

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

1. Выберите в меню элементы Инструменты>Диспетчер пакетов NuGet>Консоль диспетчера пакетов.

2. Выполните следующую команду, чтобы установить пакет NuGet Azure.Messaging.EventHubs:

   Install-Package Azure.Messaging.EventHubs
   

1. Замените существующий Program.cs код в файле следующим примером кода. Затем, замените значения заполнителей <EVENT_HUB_NAMESPACE> и <HUB_NAME> для параметров EventHubProducerClient именами области имен вашего пространства имен Event Hubs и концентратором события. Например, "spehubns0309.servicebus.windows.net" и "spehub".

   Вот важные шаги из кода:

   1. Создает объект EventHubProducerClient с помощью пространства имен и имени концентратора событий.
   2. Вызывает метод CreateBatchAsync в объекте EventHubProducerClient для создания объекта 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 код в файле следующим примером кода. Затем замените значения заполнителей <CONNECTION_STRING> для параметров <HUB_NAME> и EventHubProducerClient.

   Вот важные шаги из кода:

   1. Создание объекта EventHubProducerClient с использованием первичной строки подключения к пространству имен и имени концентратора событий.
   2. Вызов метода CreateBatchAsync для объекта EventHubProducerClient для создания объекта 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 RBAC можно назначить пользователю с помощью портала Azure, Azure CLI или Azure PowerShell. Дополнительные сведения о доступных областях назначения ролей можно узнать на странице обзора области.

В этом сценарии вы предоставите разрешения вашей учетной записи пользователя, ограниченные учетной записью хранения, чтобы обеспечить соблюдение принципа минимальных привилегий. В рамках этой практики пользователям предоставляются только минимальные необходимые разрешения, что позволяет создавать более защищенные рабочие среды.

В следующем примере роль участника данных 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 и пакеты NuGet Azure.Identity . Нажмите клавишу ВВОД , чтобы выполнить последнюю команду.

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

1. Выберите в меню элементы Инструменты>Диспетчер пакетов NuGet>Консоль диспетчера пакетов.

2. В окне Консоль диспетчера пакетов для параметра Проект по умолчанию выберите EventHubsReceiver. В противном случае в раскрывающемся списке выберите EventHubsReceiver.

3. Выполните следующую команду, чтобы установить пакет NuGet Azure.Messaging.EventHubs:

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

1. Замените существующий Program.cs код в файле следующим примером кода. Затем замените заполнители <STORAGE_ACCOUNT_NAME> и <BLOB_CONTAINER_NAME> для BlobContainerClient URI. Замените также значения заполнителей <EVENT_HUB_NAMESPACE> и <HUB_NAME> для EventProcessorClient.

   Вот важные шаги из кода:

   1. Создает объект EventProcessorClient с помощью пространства имен Центров событий и имени концентратора событий. Необходимо создать объект BlobContainerClient для контейнера в хранилище Azure, созданном ранее.
   2. Указание обработчиков для событий ProcessEventAsync и ProcessErrorAsync объекта EventProcessorClient.
   3. Запуск обработки событий путем вызова StartProcessingAsync для объекта EventProcessorClient.
   4. Останавливает обработку событий через 30 секунд, вызвав StopProcessingAsync в объекте EventProcessorClient .

   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 код в файле следующим примером кода. Затем замените значения заполнителей <AZURE_STORAGE_CONNECTION_STRING> и <BLOB_CONTAINER_NAME> для URI BlobContainerClient. Замените значения заполнителей <EVENT_HUB_NAMESPACE_CONNECTION_STRING> и <HUB_NAME> вместе с EventProcessorClient.

   Вот важные шаги из кода:

   1. Создание объекта EventProcessorClient с использованием первичной строки подключения к пространству имен и концентратора событий. Необходимо создать объект BlobContainerClient для контейнера в хранилище Azure, созданном ранее.
   2. Указание обработчиков для событий ProcessEventAsync и ProcessErrorAsync объекта EventProcessorClient.
   3. Запуск обработки событий путем вызова StartProcessingAsync для объекта EventProcessorClient.
   4. Останавливает обработку событий через 30 секунд, вызвав StopProcessingAsync в объекте EventProcessorClient .

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