Set-AzEventHub
Updates an EventHub Entity
Syntax
Set-AzEventHub
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-CaptureEnabled]
[-Encoding <EncodingCaptureDescription>]
[-IntervalInSeconds <Int32>]
[-SizeLimitInBytes <Int32>]
[-SkipEmptyArchive]
[-RetentionTimeInHour <Int64>]
[-TombstoneRetentionTimeInHour <Int32>]
[-Status <EntityStatus>]
[-DestinationName <String>]
[-IdentityType <ManagedServiceIdentityType>]
[-UserAssignedIdentityId <String>]
[-PartitionCount <Int64>]
[-StorageAccountResourceId <String>]
[-ArchiveNameFormat <String>]
[-BlobContainer <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzEventHub
-InputObject <IEventHubIdentity>
[-CaptureEnabled]
[-Encoding <EncodingCaptureDescription>]
[-IntervalInSeconds <Int32>]
[-SizeLimitInBytes <Int32>]
[-SkipEmptyArchive]
[-RetentionTimeInHour <Int64>]
[-TombstoneRetentionTimeInHour <Int32>]
[-Status <EntityStatus>]
[-DestinationName <String>]
[-IdentityType <ManagedServiceIdentityType>]
[-UserAssignedIdentityId <String>]
[-PartitionCount <Int64>]
[-StorageAccountResourceId <String>]
[-ArchiveNameFormat <String>]
[-BlobContainer <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Updates an EventHub Entity
Examples
Example 1: Set capture on an existing EventHub entity
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 AMUpdates EventHub entity myEventHub from namespace myNamespace to enable capture on it.
Example 2: Update EventHub EventHub entity using InputObject parameter set
$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 AMUpdates RetentionTimeInHour in EventHub entity myEventHub to 72 hours.
Parameters
-ArchiveNameFormat
Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BlobContainer
Blob container Name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CaptureEnabled
A value that indicates whether capture description is enabled.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DestinationName
Name for capture destination
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Encoding
Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version
| Type: | EncodingCaptureDescription |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityType
Type of managed service identity.
| Type: | ManagedServiceIdentityType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity parameter. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IEventHubIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IntervalInSeconds
The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The name of EventHub Entity.
| Type: | String |
| Aliases: | EventHubName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NamespaceName
The name of EventHub namespace.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PartitionCount
Number of partitions created for the Event Hub. allowed values are from 1 to 32 partitions.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RetentionTimeInHour
Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compaction the returned value of this property is Long.MaxValue
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SizeLimitInBytes
The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipEmptyArchive
A value that indicates whether to Skip Empty Archives
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Status
Enumerates the possible values for the status of the Event Hub.
| Type: | EntityStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StorageAccountResourceId
Resource id of the storage account to be used to create the blobs
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TombstoneRetentionTimeInHour
Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compaction. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserAssignedIdentityId
Properties for User Assigned Identities
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for