通过

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

New-AzEventHub

  • 参考
模块:
Az.EventHub

将一个新的事件中心创建为命名空间中的嵌套资源。

语法

New-AzEventHub
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-CaptureEnabled]
   [-CleanupPolicy <String>]
   [-DestinationName <String>]
   [-Encoding <String>]
   [-IdentityType <String>]
   [-IntervalInSeconds <Int32>]
   [-MinCompactionLagInMin <Int64>]
   [-PartitionCount <Int64>]
   [-RetentionTimeInHour <Int64>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-Status <String>]
   [-StorageAccountResourceId <String>]
   [-TimestampType <String>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-UserAssignedIdentityId <String>]
   [-UserMetadata <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventHub
   -Name <String>
   -NamespaceInputObject <IEventHubIdentity>
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-CaptureEnabled]
   [-CleanupPolicy <String>]
   [-DestinationName <String>]
   [-Encoding <String>]
   [-IdentityType <String>]
   [-IntervalInSeconds <Int32>]
   [-MinCompactionLagInMin <Int64>]
   [-PartitionCount <Int64>]
   [-RetentionTimeInHour <Int64>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-Status <String>]
   [-StorageAccountResourceId <String>]
   [-TimestampType <String>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-UserAssignedIdentityId <String>]
   [-UserMetadata <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventHub
   -Name <String>
   -NamespaceInputObject <IEventHubIdentity>
   -Parameter <IEventhub>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

将一个新的事件中心创建为命名空间中的嵌套资源。

示例

示例 1：创建 EventHub 实体

New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -RetentionTimeInHour 168 -PartitionCount 5 -CleanupPolicy Delete

ArchiveNameFormat            :
BlobContainer                :
CaptureEnabled               :
CleanupPolicy                : Delete
CreatedAt                    : 4/25/2023 3:55:45 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     :
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds            :
Location                     : eastus
MessageRetentionInDay        : 7
Name                         : myEventHub
PartitionCount               : 5
PartitionId                  : {0, 1, 2, 3�}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          : 168
SizeLimitInBytes             :
SkipEmptyArchive             :
Status                       : Active
StorageAccountResourceId     :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type                         : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt                    : 4/25/2023 3:55:46 AM

使用 CleaupPolicy Delete在命名空间 myNamespace 上创建新的 eventhub 实体 myEventHub。

示例 2：创建启用了捕获的 EventHub

New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -ArchiveNameFormat "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" -BlobContainer container -CaptureEnabled -DestinationName EventHubArchive.AzureBlockBlob -Encoding Avro -IntervalInSeconds 600 -SizeLimitInBytes 11000000 -SkipEmptyArchive -StorageAccountResourceId "/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount -CleanupPolicy Delete"

ArchiveNameFormat            : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer                : container
CaptureEnabled               : true
CreatedAt                    : 9/1/2022 5:55:46 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     : Avro
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myFirstEventHub
IntervalInSeconds            : 600
Location                     : centralus
MessageRetentionInDays       : 6
Name                         : myFirstEventHub
PartitionCount               : 5
PartitionId                  : {0}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          : 24
SizeLimitInBytes             : 11000000
SkipEmptyArchive             : true
Status                       : Active

在启用了捕获的命名空间 myNamespace 上创建新的 eventhub 实体 myEventHub。

示例 3：创建 EventHub 实体

New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -CleanupPolicy Compact

ArchiveNameFormat            :
BlobContainer                :
CaptureEnabled               :
CleanupPolicy                : Compact
CreatedAt                    : 4/25/2023 4:05:57 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     :
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds            :
Location                     : eastus
MessageRetentionInDay        : 9223372036854775807
Name                         : myEventHub
PartitionCount               : 4
PartitionId                  : {0, 1, 2, 3}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          :
SizeLimitInBytes             :
SkipEmptyArchive             :
Status                       : Active
StorageAccountResourceId     :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type                         : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt                    : 4/25/2023 4:05:58 AM

使用 CleaupPolicy Compact在命名空间 myNamespace 上创建新的 eventhub 实体 myEventHub。

参数

-ArchiveNameFormat

存档的 Blob 命名约定，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 在这里，所有参数（命名空间，EventHub .. 等）都是强制性的，无论顺序如何

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-BlobContainer

Blob 容器名称

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CaptureEnabled

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

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CleanupPolicy

枚举清理策略的可能值

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet，请使用 SubscriptionId 参数。

类型:PSObject
别名:AzureRMContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DestinationName

捕获目标的名称

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Encoding

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

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-IdentityType

Azure Active Directory 托管标识的类型。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-IntervalInSeconds

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

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-MinCompactionLagInMin

消息在日志中无法压缩的最短时间。 当 cleanupPolicy 为 Compact 或 DeleteOrCompact 时，将使用此值。

类型:Int64
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Name

事件中心名称

类型:String
别名:EventHubName
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-NamespaceInputObject

标识参数

类型:IEventHubIdentity
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-NamespaceName

命名空间名称

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Parameter

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

类型:IEventhub
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-PartitionCount

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

类型:Int64
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceGroupName

Azure 订阅中的资源组的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-RetentionTimeInHour

保留此事件中心的事件的小时数。 这应该是命名空间 SKU 最大值的正值。-1 是一种特殊情况，即保留时间是无限的，但实体的大小受到限制，其大小取决于命名空间 SKU 类型。

类型:Int64
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SizeLimitInBytes

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

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SkipEmptyArchive

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

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Status

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

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-StorageAccountResourceId

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

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SubscriptionId

唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。

类型:String
Position:Named
默认值:(Get-AzContext).Subscription.Id
必需:False
接受管道输入:False
接受通配符:False

-TimestampType

表示消息将保留的时间戳类型。两种类型的时间戳类型 -“AppendTime”和“CreateTime”。 AppendTime 是指在中转站日志中追加消息的时间。 CreateTime 是指在源端生成消息的时间，生成者可以在发送消息时设置此时间戳。 默认值为 AppendTime。 如果使用 AMQP 协议，CreateTime 等于 AppendTime 及其行为保持不变。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-TombstoneRetentionTimeInHour

保留压缩事件中心的逻辑删除标记的小时数。 当 cleanupPolicy 为 Compact 或 DeleteOrCompact 时，将使用此值。 使用者必须在此指定的时间范围内完成读取墓碑标记（如果使用者从起始偏移开始）以确保它们获取压缩事件中心内逻辑删除标记所描述的特定键的有效快照

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-UserAssignedIdentityId

托管用户标识的 ARM ID。 此属性是必需的，类型为 UserAssignedIdentity。 如果类型为 SystemAssigned，则将使用与命名空间关联的系统分配标识。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-UserMetadata

获取和设置用户的元数据。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

输出