Set-AzEventHub
语法
SetExpanded (默认值)
Set-AzEventHub
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-CaptureEnabled]
[-Encoding <String>]
[-IntervalInSeconds <Int32>]
[-SizeLimitInBytes <Int32>]
[-SkipEmptyArchive]
[-RetentionTimeInHour <Int64>]
[-TombstoneRetentionTimeInHour <Int32>]
[-Status <String>]
[-UserMetadata <String>]
[-MinCompactionLagInMin <Int64>]
[-TimestampType <String>]
[-DestinationName <String>]
[-IdentityType <String>]
[-UserAssignedIdentityId <String>]
[-PartitionCount <Int64>]
[-StorageAccountResourceId <String>]
[-ArchiveNameFormat <String>]
[-BlobContainer <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetViaIdentityExpanded
Set-AzEventHub
-InputObject <IEventHubIdentity>
[-CaptureEnabled]
[-Encoding <String>]
[-IntervalInSeconds <Int32>]
[-SizeLimitInBytes <Int32>]
[-SkipEmptyArchive]
[-RetentionTimeInHour <Int64>]
[-TombstoneRetentionTimeInHour <Int32>]
[-Status <String>]
[-UserMetadata <String>]
[-MinCompactionLagInMin <Int64>]
[-TimestampType <String>]
[-DestinationName <String>]
[-IdentityType <String>]
[-UserAssignedIdentityId <String>]
[-PartitionCount <Int64>]
[-StorageAccountResourceId <String>]
[-ArchiveNameFormat <String>]
[-BlobContainer <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
示例
示例 1:在现有 EventHub 实体上设置捕获
Set-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"
ArchiveNameFormat : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer : container
CaptureEnabled : True
CleanupPolicy : Delete
CreatedAt : 1/1/0001 12:00:00 AM
DataLakeAccountName :
DataLakeFolderPath :
DataLakeSubscriptionId :
DestinationName : EventHubArchive.AzureBlockBlob
Encoding : Avro
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/namespace3/eventhubs/myEventHub
IntervalInSeconds : 600
Location : eastus
MessageRetentionInDay : 7
Name : myEventHub
PartitionCount : 5
PartitionId : {}
ResourceGroupName : myResourceGroup
RetentionTimeInHour : 168
SizeLimitInBytes : 11000000
SkipEmptyArchive : True
Status : Active
StorageAccountResourceId : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt : 1/1/0001 12:00:00 AM
从命名空间myEventHub更新 EventHub 实体myNamespace以启用捕获。
$eventhub = Get-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace
Set-AzEventHub -InputObject $eventhub -RetentionTimeInHour 72
ArchiveNameFormat : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer : container1entHub]>
CaptureEnabled : True
CleanupPolicy : Delete
CreatedAt : 1/1/0001 12:00:00 AM
DataLakeAccountName :
DataLakeFolderPath :
DataLakeSubscriptionId :
DestinationName : EventHubArchive.AzureBlockBlob
Encoding : Avro
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds : 600
Location : eastus
MessageRetentionInDay : 3
Name : myEventHub
PartitionCount : 5
PartitionId : {}
ResourceGroupName : myResourceGroup
RetentionTimeInHour : 72
SizeLimitInBytes : 11000000
SkipEmptyArchive : True
Status : Active
StorageAccountResourceId : /subscriptions/subscriptionId/resourceGroups/myResourcegroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount
1
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt : 1/1/0001 12:00:00 AM
EventHub 实体RetentionTimeInHour中的更新myEventHub为 72 小时。
参数
存档的 Blob 命名约定,例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。
此处的所有参数(Namespace,EventHub .. 等)都是强制性的,无论顺序如何
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-AsJob
以作业身份运行命令
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-BlobContainer
Blob 容器名称
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-CaptureEnabled
一个值,该值指示是否启用捕获说明。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Confirm
在运行 cmdlet 之前,提示你进行确认。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
参数属性
| 类型: | PSObject
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | AzureRMContext, AzureCredential |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DestinationName
捕获目标的名称
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Encoding
枚举捕获说明的编码格式的可能值。
注意:新 API 版本中将弃用“AvroDeflate”
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-IdentityType
托管服务标识的类型。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
标识参数。
若要构造,请参阅 INPUTOBJECT 属性的 NOTES 部分并创建哈希表。
SetViaIdentityExpanded
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-IntervalInSeconds
使用时间范围可以设置捕获到 Azure Blob 的频率,值应介于 60 到 900 秒之间
参数属性
| 类型: | Int32
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-MinCompactionLagInMin
消息在日志中无法压缩的最短时间。
参数属性
| 类型: | Int64
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Name
EventHub 实体的名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | EventHubName |
参数集
SetExpanded
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-NamespaceName
EventHub 命名空间的名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
SetExpanded
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-NoWait
异步运行命令
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PartitionCount
为事件中心创建的分区数。
允许的值从 1 到 32 个分区。
参数属性
| 类型: | Int64
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ResourceGroupName
资源组的名称。
此名称不区分大小写。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
SetExpanded
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RetentionTimeInHour
保留此事件中心的事件的小时数。
仅当 cleanupPolicy 为 Delete 时,才使用此值。
如果 cleanupPolicy 是 Compaction,则此属性的返回值为 Long.MaxValue
参数属性
| 类型: | Int64
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SizeLimitInBytes
大小窗口定义在捕获操作之前在事件中心生成的数据量,值应在10485760到524288000字节之间
参数属性
| 类型: | Int32
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SkipEmptyArchive
一个值,该值指示是否跳过空存档
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Status
枚举事件中心状态的可能值。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-StorageAccountResourceId
用于创建 Blob 的存储帐户的资源 ID
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SubscriptionId
目标订阅的 ID。
参数属性
| 类型: | String
|
| 默认值: | (Get-AzContext).Subscription.Id |
| 支持通配符: | False |
| 不显示: | False |
参数集
SetExpanded
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-TimestampType
表示消息将保留的时间戳类型。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-TombstoneRetentionTimeInHour
保留压缩事件中心的逻辑删除标记的小时数。
仅当 cleanupPolicy 为 Compaction 时,才使用此值。
使用者必须在此指定的时间范围内完成读取墓碑标记(如果使用者从起始偏移开始)以确保它们获取压缩事件中心内逻辑删除标记所描述的特定键的有效快照
参数属性
| 类型: | Int32
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-UserAssignedIdentityId
用户分配标识的属性
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
获取和设置用户的元数据。
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-WhatIf
显示 cmdlet 运行时会发生什么情况。
命令脚本未运行。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输出