Set-AzEventHub
Updates the specified Event Hub.
Syntaxe
Set-AzEventHub
[-ResourceGroupName] <String>
[-Namespace] <String>
[-Name] <String>
[-InputObject <PSEventHubAttributes>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
EventhubPropertiesSet
Set-AzEventHub
[-ResourceGroupName] <String>
[-Namespace] <String>
[-Name] <String>
[-messageRetentionInDays <Int64>]
[-partitionCount <Int64>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzEventHub cmdlet updates the properties of the specified Event Hub.
Příklady
Example 1
To update Eventhub with Capture description properties, please follow the below steps.
PS C:\> $CreatedEventHub = Get-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName
PS C:\> $createdEventHub.CaptureDescription = New-Object -TypeName Microsoft.Azure.Commands.EventHub.Models.PSCaptureDescriptionAttributes
PS C:\> $createdEventHub.CaptureDescription.Enabled = $true
PS C:\> $createdEventHub.CaptureDescription.IntervalInSeconds = 120
PS C:\> $createdEventHub.CaptureDescription.Encoding = "Avro"
PS C:\> $createdEventHub.CaptureDescription.SizeLimitInBytes = 10485763
PS C:\> $createdEventHub.CaptureDescription.Destination.Name = "EventHubArchive.AzureBlockBlob"
PS C:\> $createdEventHub.CaptureDescription.Destination.BlobContainer = "container"
PS C:\> $createdEventHub.CaptureDescription.Destination.ArchiveNameFormat = "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
PS C:\> $createdEventHub.CaptureDescription.Destination.StorageAccountResourceId = "/subscriptions/{SubscriptionId}/resourceGroups/MyResourceGroupName/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage"
PS C:\> Set-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject MyCreatedEventHub -messageRetentionInDays 4 -partitionCount 2
Updates the Event Hub `MyEventHubName` represented by the `MyCreatedEventHub` object, setting the message retention period to 4 days, the number of partitions to 2 and CaptureDescription properties
Example 2
PS C:\> Set-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject MyCreatedEventHub -messageRetentionInDays 4 -partitionCount 2
Updates the Event Hub `MyEventHubName` represented by the `MyCreatedEventHub` object, setting the message retention period to 4 days, and the number of partitions to 2.
Parametry
-Confirm
Prompts you for confirmation before running the cmdlet.
Vlastnosti parametru
Typ: SwitchParameter
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Aliasy: cf
Sady parametrů
(All)
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Vlastnosti parametru
Typ: IAzureContextContainer
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Aliasy: AzContext, AzureRmContext, AzureCredential
Sady parametrů
(All)
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
EventHub object
Typ: PSEventHubAttributes
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Aliasy: EventHubObj
EventhubInputObjectSet
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
-messageRetentionInDays
Eventhub Message Retention In Days
Vlastnosti parametru
Typ: Nullable<T> [ Int64 ]
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
EventhubPropertiesSet
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
-Name
Namespace Name
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Aliasy: EventHubName
Sady parametrů
(All)
Position: 2
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
-Namespace
Namespace Name
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Aliasy: NamespaceName
Sady parametrů
(All)
Position: 1
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
-partitionCount
Eventhub PartitionCount
Vlastnosti parametru
Typ: Nullable<T> [ Int64 ]
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
EventhubPropertiesSet
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
-ResourceGroupName
Resource Group Name
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
(All)
Position: 0
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Vlastnosti parametru
Typ: SwitchParameter
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Aliasy: wi
Sady parametrů
(All)
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Výstupy