你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	命名空间名称 正则表达式模式: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName	path	True	string	Azure 订阅中的资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。
$skip	query		integer	仅当上一个操作返回了部分结果时，才使用 Skip。 如果以前的响应包含 nextLink 元素，则 nextLink 元素的值将包含一个 skip 参数，该参数指定要用于后续调用的起点。
$top	query		integer	可用于将结果数限制为最近的 N usageDetail。

响应

名称	类型	说明
200 OK	EventHubListResult	已成功检索事件中心列表。
Other Status Codes	ErrorResponse	描述操作失败原因的 Eventhub 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: 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	枚举捕获说明编码格式的可能值。 注意：新 API 版本中将弃用“AvroDeflate”
EntityStatus	枚举事件中心状态的可能值。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应指示事件中心服务无法处理传入请求。 错误消息中提供了原因。
Eventhub	列表或获取事件中心操作中的单个项
EventHubListResult	List EventHubs 操作的结果。
RetentionDescription	用于配置 eventhub 保留设置的属性
systemData	与资源的创建和上次修改相关的元数据。

CaptureDescription

用于为 eventhub 配置捕获说明的属性

名称	类型	说明
destination	Destination	要存储捕获的目标的属性。 (存储帐户、Blob 名称)
enabled	boolean	一个 值，该值指示是否启用捕获说明。
encoding	EncodingCaptureDescription	枚举捕获说明编码格式的可能值。 注意：新 API 版本中将弃用“AvroDeflate”
intervalInSeconds	integer	使用时间范围可以设置捕获到 Azure Blob 的频率，值应介于 60 到 900 秒之间
sizeLimitInBytes	integer	大小窗口定义捕获操作之前事件中心内生成的数据量，值应介于 10485760 到 524288000 个字节之间
skipEmptyArchives	boolean	一个值，该值指示是否跳过空存档

CaptureIdentity

一个 值，该值指示是否启用捕获说明。

名称	类型	说明
type	CaptureIdentityType	Azure Active Directory 托管标识的类型。
userAssignedIdentity	string	托管用户标识的 ARM ID。 此属性是必需的，类型为 UserAssignedIdentity。 如果 type 为 SystemAssigned，则将使用与命名空间关联的系统分配标识。

CaptureIdentityType

Azure Active Directory 托管标识的类型。

名称	类型	说明
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

枚举清理策略的可能值

名称	类型	说明
Compact	string
Delete	string

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

捕获描述的捕获存储详细信息

名称	类型	说明
identity	CaptureIdentity	一个 值，该值指示是否启用捕获说明。
name	string	捕获目标的名称
properties.archiveNameFormat	string	存档的 Blob 命名约定，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 此处的所有参数 (Namespace，EventHub 。等) 是强制性的，无论顺序如何
properties.blobContainer	string	Blob 容器名称
properties.dataLakeAccountName	string	捕获事件的 Azure Data Lake Store 名称
properties.dataLakeFolderPath	string	捕获事件的目标文件夹路径
properties.dataLakeSubscriptionId	string	Azure Data Lake Store 的订阅 ID
properties.storageAccountResourceId	string	要用于创建 Blob 的存储帐户的资源 ID

EncodingCaptureDescription

枚举捕获说明编码格式的可能值。 注意：新 API 版本中将弃用“AvroDeflate”

名称	类型	说明
Avro	string
AvroDeflate	string

EntityStatus

枚举事件中心状态的可能值。

名称	类型	说明
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应指示事件中心服务无法处理传入请求。 错误消息中提供了原因。

名称	类型	说明
error	ErrorDetail	错误对象。

Eventhub

列表或获取事件中心操作中的单个项

名称	类型	说明
id	string	资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	资源所在的地理位置
name	string	资源的名称
properties.captureDescription	CaptureDescription	捕获说明的属性
properties.createdAt	string	创建事件中心的确切时间。
properties.messageRetentionInDays	integer	为此事件中心保留事件的天数，值应为 1 到 7 天
properties.partitionCount	integer	为事件中心创建的分区数，允许的值为 1 到 32 个分区。
properties.partitionIds	string[]	事件中心上的当前分片数。
properties.retentionDescription	RetentionDescription	事件中心保留设置
properties.status	EntityStatus	枚举事件中心状态的可能值。
properties.updatedAt	string	消息的确切更新时间。
properties.userMetadata	string	获取和设置用户的元数据。
systemData	systemData	与此资源相关的系统元数据。
type	string	资源类型。 例如“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”

EventHubListResult

List EventHubs 操作的结果。

名称	类型	说明
nextLink	string	链接到下一组结果。 如果 Value 包含 EventHub 的不完整列表，则不为空。
value	Eventhub[]	List EventHubs 操作的结果。

RetentionDescription

用于配置 eventhub 保留设置的属性

名称	类型	说明
cleanupPolicy	CleanupPolicyRetentionDescription	枚举清理策略的可能值
retentionTimeInHours	integer	保留此事件中心的事件的小时数。 仅当 cleanupPolicy 为 Delete 时才使用此值。 如果 cleanupPolicy 为 Compact，则此属性的返回值为 Long.MaxValue
tombstoneRetentionTimeInHours	integer	保留压缩事件中心的逻辑删除标记的小时数。 仅当 cleanupPolicy 为 Compact 时才使用此值。 如果使用者从开始偏移量开始，则使用者必须在指定的时间内完成对逻辑删除标记的读取，以确保在压缩事件中心内获得由逻辑删除标记描述的特定键的有效快照

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	上次修改资源的标识类型。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。