Set-AzEventHub

參考

模組:: Az.EventHub

更新 EventHub 實體

Syntax

Set-AzEventHub
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-CaptureEnabled]
   [-Encoding <String>]
   [-IntervalInSeconds <Int32>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-RetentionTimeInHour <Int64>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-Status <String>]
   [-DestinationName <String>]
   [-IdentityType <String>]
   [-UserAssignedIdentityId <String>]
   [-PartitionCount <Int64>]
   [-StorageAccountResourceId <String>]
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzEventHub
   -InputObject <IEventHubIdentity>
   [-CaptureEnabled]
   [-Encoding <String>]
   [-IntervalInSeconds <Int32>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-RetentionTimeInHour <Int64>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-Status <String>]
   [-DestinationName <String>]
   [-IdentityType <String>]
   [-UserAssignedIdentityId <String>]
   [-PartitionCount <Int64>]
   [-StorageAccountResourceId <String>]
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

更新 EventHub 實體

範例

範例 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

從命名空間 myNamespace 更新 EventHub 實體myEventHub，以啟用擷取。

範例 2：使用 InputObject 參數集更新 EventHub EventHub 實體

$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 實體myEventHub中更新 RetentionTimeInHour 到 72 小時。

參數

-ArchiveNameFormat

封存的 Blob 命名慣例，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。在這裡，所有參數（Namespace，EventHub .. etc）都是強制性的，不論順序為何

類型:	String
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

以作業身分執行命令

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BlobContainer

Blob 容器名稱

類型:	String
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CaptureEnabled

值，指出是否啟用擷取描述。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

執行 Cmdlet 之前先提示您確認。

類型:	SwitchParameter
Aliases:	cf
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DestinationName

擷取目的地的名稱

類型:	String
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Encoding

列舉擷取描述編碼格式的可能值。注意：新 API 版本中將會淘汰 'AvroDeflate'

類型:	String
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityType

受控服務識別的類型。

類型:	String
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

識別參數。若要建構，請參閱 INPUTOBJECT 屬性的 NOTES 區段並建立哈希表。

類型:	IEventHubIdentity
Position:	Named
預設值:	None
必要:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IntervalInSeconds

時間範圍可讓您設定擷取至 Azure Blob 的頻率，值應介於 60 到 900 秒之間

類型:	Int32
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

EventHub 實體的名稱。

類型:	String
Aliases:	EventHubName
Position:	Named
預設值:	None
必要:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NamespaceName

EventHub 命名空間的名稱。

類型:	String
Position:	Named
預設值:	None
必要:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

以異步方式執行命令

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PartitionCount

為事件中樞建立的數據分割數目。允許的值是從 1 到 32 個分割區。

類型:	Int64
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

資源群組的名稱。名稱不區分大小寫。

類型:	String
Position:	Named
預設值:	None
必要:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RetentionTimeInHour

保留此事件中樞事件的時數。只有在 cleanupPolicy 為 Delete 時，才會使用此值。如果 cleanupPolicy 是 Compaction，則此屬性的傳回值為 Long.MaxValue

類型:	Int64
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SizeLimitInBytes

大小視窗會在擷取作業之前定義事件中樞內建的數據量，值應該介於10485760到524288000個字節之間

類型:	Int32
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipEmptyArchive

值，指出是否略過空白封存

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Status

列舉事件中樞狀態的可能值。

類型:	String
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StorageAccountResourceId

要用來建立 Blob 的記憶體帳戶資源識別碼

類型:	String
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

目標訂用帳戶的標識碼。

類型:	String
Position:	Named
預設值:	(Get-AzContext).Subscription.Id
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TombstoneRetentionTimeInHour

保留壓縮事件中樞之墓碑標記的時數。只有在 cleanupPolicy 為 Compaction 時，才會使用此值。如果取用者從起始位移開始，必須完成讀取此指定時間範圍內的墓碑標記，以確保取用者在壓縮事件中樞內為墓碑標記所描述的特定索引鍵取得有效的快照集

類型:	Int32
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserAssignedIdentityId

使用者指派身分識別的屬性

類型:	String
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。未執行 Cmdlet。

類型:	SwitchParameter
Aliases:	wi
Position:	Named
預設值:	None
必要:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

IEventHubIdentity

輸出

IEventhub

共用方式為