Event Hubs - List By Namespace

Служба:

Event Hubs

Версия API:

2024-01-01

Возвращает все центры событий в пространстве имен.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs?api-version=2024-01-01

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs?api-version=2024-01-01&$skip={$skip}&$top={$top}

Параметры URI

Имя	В	Обязательно	Тип	Описание
namespaceName	path	True	string minLength: 6 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$	Имя пространства имен
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов в подписке Azure.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
$skip	query		integer minimum: 0 maximum: 1000	Пропуск используется только в том случае, если предыдущая операция вернула частичный результат. Если предыдущий ответ содержит элемент nextLink, значение элемента nextLink будет включать параметр пропуска, указывающий начальную точку для последующих вызовов.
$top	query		integer minimum: 1 maximum: 1000	Можно использовать для ограничения количества результатов до последних N usageDetails.

Ответы

Имя	Тип	Описание
200 OK	EventHubListResult	Успешно получен список центров событий.
Other Status Codes	ErrorResponse	Ответ об ошибке eventhub, описывающий, почему операция завершилась ошибкой.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

EventHubsListAll

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5357/eventhubs?api-version=2024-01-01

Java

/**
 * Samples for EventHubs ListByNamespace.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/
     * EHEventHubListByNameSpace.json
     */
    /**
     * Sample code: EventHubsListAll.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void eventHubsListAll(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.eventHubs().manager().serviceClient().getEventHubs().listByNamespace(
            "Default-NotificationHubs-AustraliaEast", "sdk-Namespace-5357", null, null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.eventhub import EventHubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventhub
# USAGE
    python eh_event_hub_list_by_name_space.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventHubManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e2f361f0-3b27-4503-a9cc-21cfba380093",
    )

    response = client.event_hubs.list_by_namespace(
        resource_group_name="Default-NotificationHubs-AustraliaEast",
        namespace_name="sdk-Namespace-5357",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/EHEventHubListByNameSpace.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armeventhub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventhub/armeventhub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b574e2a41acda14a90ef237006e8bbdda2b63c63/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/EHEventHubListByNameSpace.json
func ExampleEventHubsClient_NewListByNamespacePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewEventHubsClient().NewListByNamespacePager("Default-NotificationHubs-AustraliaEast", "sdk-Namespace-5357", &armeventhub.EventHubsClientListByNamespaceOptions{Skip: nil,
		Top: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListResult = armeventhub.ListResult{
		// 	Value: []*armeventhub.Eventhub{
		// 		{
		// 			Name: to.Ptr("sdk-eventhub-10"),
		// 			Type: to.Ptr("Microsoft.EventHub/Namespaces/EventHubs"),
		// 			ID: to.Ptr("/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-716/eventhubs/sdk-eventhub-10"),
		// 			Properties: &armeventhub.Properties{
		// 				CaptureDescription: &armeventhub.CaptureDescription{
		// 					Destination: &armeventhub.Destination{
		// 						Name: to.Ptr("EventHubArchive.AzureBlockBlob"),
		// 						Properties: &armeventhub.DestinationProperties{
		// 							ArchiveNameFormat: to.Ptr("{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"),
		// 							BlobContainer: to.Ptr("container"),
		// 							StorageAccountResourceID: to.Ptr("/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage"),
		// 						},
		// 					},
		// 					Enabled: to.Ptr(true),
		// 					Encoding: to.Ptr(armeventhub.EncodingCaptureDescriptionAvro),
		// 					IntervalInSeconds: to.Ptr[int32](120),
		// 					SizeLimitInBytes: to.Ptr[int32](10485763),
		// 				},
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-28T02:45:55.877Z"); return t}()),
		// 				MessageRetentionInDays: to.Ptr[int64](4),
		// 				PartitionCount: to.Ptr[int64](4),
		// 				PartitionIDs: []*string{
		// 					to.Ptr("0"),
		// 					to.Ptr("1"),
		// 					to.Ptr("2"),
		// 					to.Ptr("3")},
		// 					RetentionDescription: &armeventhub.RetentionDescription{
		// 						CleanupPolicy: to.Ptr(armeventhub.CleanupPolicyRetentionDescriptionDelete),
		// 						RetentionTimeInHours: to.Ptr[int64](96),
		// 						TombstoneRetentionTimeInHours: to.Ptr[int32](1),
		// 					},
		// 					Status: to.Ptr(armeventhub.EntityStatusActive),
		// 					UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-28T02:46:05.877Z"); return t}()),
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { EventHubManagementClient } = require("@azure/arm-eventhub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all the Event Hubs in a Namespace.
 *
 * @summary Gets all the Event Hubs in a Namespace.
 * x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/EHEventHubListByNameSpace.json
 */
async function eventHubsListAll() {
  const subscriptionId =
    process.env["EVENTHUB_SUBSCRIPTION_ID"] || "e2f361f0-3b27-4503-a9cc-21cfba380093";
  const resourceGroupName =
    process.env["EVENTHUB_RESOURCE_GROUP"] || "Default-NotificationHubs-AustraliaEast";
  const namespaceName = "sdk-Namespace-5357";
  const credential = new DefaultAzureCredential();
  const client = new EventHubManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.eventHubs.listByNamespace(resourceGroupName, namespaceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EventHubs.Models;
using Azure.ResourceManager.EventHubs;

// Generated from example definition: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/EHEventHubListByNameSpace.json
// this example is just showing the usage of "EventHubs_ListByNamespace" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this EventHubsNamespaceResource created on azure
// for more information of creating EventHubsNamespaceResource, please refer to the document of EventHubsNamespaceResource
string subscriptionId = "e2f361f0-3b27-4503-a9cc-21cfba380093";
string resourceGroupName = "Default-NotificationHubs-AustraliaEast";
string namespaceName = "sdk-Namespace-5357";
ResourceIdentifier eventHubsNamespaceResourceId = EventHubsNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
EventHubsNamespaceResource eventHubsNamespace = client.GetEventHubsNamespaceResource(eventHubsNamespaceResourceId);

// get the collection of this EventHubResource
EventHubCollection collection = eventHubsNamespace.GetEventHubs();

// invoke the operation and iterate over the result
await foreach (EventHubResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EventHubData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:

200

{
  "value": [
    {
      "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-716/eventhubs/sdk-eventhub-10",
      "name": "sdk-eventhub-10",
      "type": "Microsoft.EventHub/Namespaces/EventHubs",
      "properties": {
        "messageRetentionInDays": 4,
        "partitionCount": 4,
        "status": "Active",
        "createdAt": "2017-06-28T02:45:55.877Z",
        "updatedAt": "2017-06-28T02:46:05.877Z",
        "partitionIds": [
          "0",
          "1",
          "2",
          "3"
        ],
        "captureDescription": {
          "enabled": true,
          "encoding": "Avro",
          "destination": {
            "name": "EventHubArchive.AzureBlockBlob",
            "properties": {
              "storageAccountResourceId": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage",
              "blobContainer": "container",
              "archiveNameFormat": "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
            }
          },
          "intervalInSeconds": 120,
          "sizeLimitInBytes": 10485763
        },
        "retentionDescription": {
          "cleanupPolicy": "Delete",
          "retentionTimeInHours": 96,
          "tombstoneRetentionTimeInHours": 1
        }
      }
    }
  ]
}

Определения

Имя	Описание
CaptureDescription	Свойства для настройки описания записи для eventhub
CaptureIdentity	Значение, указывающее, включено ли описание записи.
CaptureIdentityType	Тип управляемого удостоверения Azure Active Directory.
CleanupPolicyRetentionDescription	Перечисляет возможные значения политики очистки
createdByType	Тип удостоверения, создавшего ресурс.
Destination	Запись сведений о хранилище для описания записи
EncodingCaptureDescription	Перечисляет возможные значения для формата кодирования описания записи. Примечание. AvroDeflate не рекомендуется использовать новую версию API.
EntityStatus	Перечисляет возможные значения состояния концентратора событий.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба Концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке.
Eventhub	Один элемент в операции List или Get Event Hub
EventHubListResult	Результат операции List EventHubs.
RetentionDescription	Свойства для настройки параметров хранения для концентратора событий
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CaptureDescription

Object

Свойства для настройки описания записи для eventhub

Имя	Тип	Описание
destination	Destination	Свойства назначения, где будет храниться запись. (Учетная запись хранения, имена BLOB-объектов)
enabled	boolean	Значение, указывающее, включено ли описание записи.
encoding	EncodingCaptureDescription	Перечисляет возможные значения для формата кодирования описания записи. Примечание. AvroDeflate не рекомендуется использовать новую версию API.
intervalInSeconds	integer (int32)	Период времени позволяет задать частоту, с которой будет выполняться запись больших двоичных объектов Azure, значение должно составлять от 60 до 900 секунд.
sizeLimitInBytes	integer (int32)	Окно размера определяет объем данных, созданных в Концентраторе событий перед операцией записи, значение должно находиться между 10485760 до 524288000 байтов.
skipEmptyArchives	boolean	Значение, указывающее, следует ли пропускать пустые архивы

CaptureIdentity

Object

Значение, указывающее, включено ли описание записи.

Имя	Тип	Описание
type	CaptureIdentityType	Тип управляемого удостоверения Azure Active Directory.
userAssignedIdentity	string	Идентификатор ARM управляемого удостоверения пользователя. Это свойство является обязательным типом UserAssignedIdentity. Если тип SystemAssigned, будет использоваться удостоверение, связанное с пространством имен, связанное с системой.

CaptureIdentityType

Перечисление

Тип управляемого удостоверения Azure Active Directory.

Значение	Описание
SystemAssigned
UserAssigned

CleanupPolicyRetentionDescription

Перечисление

Перечисляет возможные значения политики очистки

Значение	Описание
Compact
Delete

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

Destination

Object

Запись сведений о хранилище для описания записи

Имя	Тип	Описание
identity	CaptureIdentity	Значение, указывающее, включено ли описание записи.
name	string	Имя назначения записи
properties.archiveNameFormat	string	Соглашение об именовании BLOB-объектов для архива, например {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Здесь все параметры (пространство имен, EventHub и т. д.) являются обязательными независимо от порядка.
properties.blobContainer	string	Имя контейнера BLOB-объектов
properties.dataLakeAccountName	string	Имя Azure Data Lake Store для захваченных событий
properties.dataLakeFolderPath	string	Путь к целевой папке для захваченных событий
properties.dataLakeSubscriptionId	string (uuid)	Идентификатор подписки Azure Data Lake Store
properties.storageAccountResourceId	string	Идентификатор ресурса учетной записи хранения, используемой для создания больших двоичных объектов

EncodingCaptureDescription

Перечисление

Перечисляет возможные значения для формата кодирования описания записи. Примечание. AvroDeflate не рекомендуется использовать новую версию API.

Значение	Описание
Avro
AvroDeflate

EntityStatus

Перечисление

Перечисляет возможные значения состояния концентратора событий.

Значение	Описание
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку указывает, что служба Концентратора событий не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

Eventhub

Object

Один элемент в операции List или Get Event Hub

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.captureDescription	CaptureDescription	Свойства описания записи
properties.createdAt	string (date-time)	Точное время создания Концентратора событий.
properties.messageRetentionInDays	integer (int64) minimum: 1	Количество дней для сохранения событий для этого концентратора событий должно составлять от 1 до 7 дней.
properties.partitionCount	integer (int64) minimum: 1	Число секций, созданных для концентратора событий, допустимые значения — от 1 до 32 секций.
properties.partitionIds	string[]	Текущее количество сегментов в Концентраторе событий.
properties.retentionDescription	RetentionDescription	Параметры хранения Концентратора событий
properties.status	EntityStatus	Перечисляет возможные значения состояния концентратора событий.
properties.updatedAt	string (date-time)	Точное время обновления сообщения.
properties.userMetadata	string	Возвращает и задает метаданные пользователя.
systemData	systemData	Системные метаданные, относящиеся к этому ресурсу.
type	string	Тип ресурса. Например, "Microsoft.EventHub/Namespaces" или "Microsoft.EventHub/Namespaces/EventHubs"

EventHubListResult

Object

Результат операции List EventHubs.

Имя	Тип	Описание
nextLink	string	Ссылка на следующий набор результатов. Не пусто, если значение содержит неполный список EventHubs.
value	Eventhub[]	Результат операции List EventHubs.

RetentionDescription

Object

Свойства для настройки параметров хранения для концентратора событий

Имя	Тип	Описание
cleanupPolicy	CleanupPolicyRetentionDescription	Перечисляет возможные значения политики очистки
retentionTimeInHours	integer (int64)	Количество часов для сохранения событий для этого концентратора событий. Это значение используется только в том случае, если параметр cleanupPolicy — Delete. Если cleanupPolicy имеет значение Compact, возвращаемое значение этого свойства, — Long.MaxValue
tombstoneRetentionTimeInHours	integer (int32)	Количество часов для хранения маркеров сложенного концентратора событий. Это значение используется только в том случае, если cleanupPolicy имеет значение Compact. Потребитель должен завершить чтение маркера могилы в течение указанного периода времени, если потребитель начинает с начала смещения, чтобы убедиться, что они получают допустимый моментальный снимок для определенного ключа, описанного маркером могилы в сжатом концентраторе событий.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Тип удостоверения, который последний раз изменил ресурс.
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.