Share via


Set-AzEventHub

Uppdateringar en EventHub-entitet

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

Uppdateringar en EventHub-entitet

Exempel

Exempel 1: Ange avbildning på en befintlig EventHub-entitet

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

Uppdateringar EventHub-entitet myEventHub från namnområdet myNamespace för att aktivera avbildning på den.

Exempel 2: Uppdatera EventHub EventHub-entiteten med hjälp av Parameteruppsättningen InputObject

$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

RetentionTimeInHour Uppdateringar i Entiteten myEventHub EventHub till 72 timmar.

Parametrar

-ArchiveNameFormat

Namngivningskonvention för blobar för arkiv, t.ex. {Namnområde}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Här är alla parametrar (namnområde, EventHub osv.) obligatoriska oavsett ordning

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

Kör kommandot som ett jobb

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BlobContainer

Namn på blobcontainer

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CaptureEnabled

Ett värde som anger om avbildningsbeskrivningen är aktiverad.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationName

Namn på avbildningsmål

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encoding

Räknar upp möjliga värden för kodningsformatet för avbildningsbeskrivningen. Obs! "AvroDeflate" kommer att bli inaktuell i ny API-version

Type:EncodingCaptureDescription
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityType

Typ av hanterad tjänstidentitet.

Type:ManagedServiceIdentityType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identitetsparameter. Information om hur du skapar finns i AVSNITTET ANTECKNINGAR för INPUTOBJECT-egenskaper och skapa en hash-tabell.

Type:IEventHubIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IntervalInSeconds

Med tidsfönstret kan du ange hur ofta avbildningen ska ske till Azure Blobs, värdet ska vara mellan 60 och 900 sekunder

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Namnet på Entiteten EventHub.

Type:String
Aliases:EventHubName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NamespaceName

Namnet på EventHub-namnområdet.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Kör kommandot asynkront

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PartitionCount

Antal partitioner som skapats för händelsehubben. tillåtna värden är från 1 till 32 partitioner.

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RetentionTimeInHour

Antal timmar för att behålla händelserna för den här händelsehubben. Det här värdet används bara när cleanupPolicy är Ta bort. Om cleanupPolicy är Compaction är det returnerade värdet för den här egenskapen Long.MaxValue

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SizeLimitInBytes

Storleksfönstret definierar mängden data som har byggts upp i händelsehubben innan en avbildningsåtgärd. Värdet ska ligga mellan 10485760 för att 524288000 byte

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkipEmptyArchive

Ett värde som anger om du vill hoppa över tomma arkiv

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Status

Räknar upp möjliga värden för händelsehubbens status.

Type:EntityStatus
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StorageAccountResourceId

Resurs-ID för lagringskontot som ska användas för att skapa blobarna

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

ID för målprenumerationen.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TombstoneRetentionTimeInHour

Antal timmar för att behålla gravstensmarkörerna för en komprimerad händelsehubb. Det här värdet används endast när cleanupPolicy är Compaction. Konsumenten måste slutföra läsningen av gravstensmarkören inom den angivna tidsperioden om konsumenten börjar starta förskjutningen för att säkerställa att de får en giltig ögonblicksbild för den specifika nyckeln som beskrivs av gravstensmarkören i den komprimerade händelsehubben

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserAssignedIdentityId

Egenskaper för användartilldelade identiteter

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Indata

IEventHubIdentity

Utdata

IEventhub