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

Event Hubs - List By Namespace

获取命名空间中的所有事件中心。

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

URI 参数

Name In Required Type Description
namespaceName
path True
  • string

命名空间名称

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 usageDetails。

响应

Name Type Description
200 OK

已成功检索事件中心列表。

Other Status Codes

描述操作失败的原因的 Eventhub 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

EventHubsListAll

Sample Request

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=2021-11-01

Sample Response

{
  "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
        }
      }
    }
  ]
}

定义

CaptureDescription

配置事件中心捕获说明的属性

createdByType

创建资源的标识的类型。

Destination

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

EncodingCaptureDescription

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

EntityStatus

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

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

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

Eventhub

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

EventHubListResult

List EventHubs 操作的结果。

systemData

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

CaptureDescription

配置事件中心捕获说明的属性

Name Type Description
destination

将存储捕获的目标的属性。 (存储帐户、Blob 名称)

enabled
  • boolean

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

encoding

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

intervalInSeconds
  • integer

使用时间范围可以设置捕获到 Azure Blob 的频率,值应介于 60 到 900 秒之间

sizeLimitInBytes
  • integer

大小窗口定义在捕获操作之前在事件中心生成的数据量,值应介于10485760到524288000字节之间

skipEmptyArchives
  • boolean

一个值,该值指示是否跳过空存档

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Destination

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

Name Type Description
name
  • string

捕获目标的名称

properties.archiveNameFormat
  • string

存档的 Blob 命名约定,例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 此处的所有参数 (Namespace,EventHub ..etc) 是强制性的,无论顺序如何

properties.blobContainer
  • string

Blob 容器名称

properties.dataLakeAccountName
  • string

捕获事件的 Azure Data Lake Microsoft Store名称

properties.dataLakeFolderPath
  • string

捕获事件的目标文件夹路径

properties.dataLakeSubscriptionId
  • string

Azure Data Lake Microsoft Store的订阅 ID

properties.storageAccountResourceId
  • string

用于创建 Blob 的存储帐户的资源 ID

EncodingCaptureDescription

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

Name Type Description
Avro
  • string
AvroDeflate
  • string

EntityStatus

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

Name Type Description
Active
  • string
Creating
  • string
Deleting
  • string
Disabled
  • string
ReceiveDisabled
  • string
Renaming
  • string
Restoring
  • string
SendDisabled
  • string
Unknown
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

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

Name Type Description
error

错误对象。

Eventhub

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

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties.captureDescription

捕获说明的属性

properties.createdAt
  • string

创建事件中心的确切时间。

properties.messageRetentionInDays
  • integer

保留此事件中心的事件的天数,值应为 1 到 7 天

properties.partitionCount
  • integer

为事件中心创建的分区数,允许的值从 1 到 32 个分区。

properties.partitionIds
  • string[]

事件中心上的当前分片数。

properties.status

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

properties.updatedAt
  • string

消息更新的确切时间。

systemData

与此资源相关的系统元数据。

type
  • string

资源类型。 例如“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”

EventHubListResult

List EventHubs 操作的结果。

Name Type Description
nextLink
  • string

链接到下一组结果。 如果 Value 包含 EventHubs 的不完整列表,则不为空。

value

List EventHubs 操作的结果。

systemData

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

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

上次修改资源的标识的类型。

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。