Dela via


Set-AzEventHub

Uppdaterar en EventHub-entitet

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

Uppdaterar 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

Uppdaterar EventHub-entiteten 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

Uppdateringar RetentionTimeInHour 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

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-AsJob

Kör kommandot som ett jobb

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-BlobContainer

Namn på blobcontainer

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-CaptureEnabled

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

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Confirm

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

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DefaultProfile

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

Typ:PSObject
Alias:AzureRMContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DestinationName

Namn på avbildningsmål

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken: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

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-IdentityType

Typ av hanterad tjänstidentitet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-InputObject

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

Typ:IEventHubIdentity
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken: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

Typ:Int32
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Name

Namnet på Entiteten EventHub.

Typ:String
Alias:EventHubName
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-NamespaceName

Namnet på EventHub-namnområdet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-NoWait

Kör kommandot asynkront

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-PartitionCount

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

Typ:Int64
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ResourceGroupName

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

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken: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

Typ:Int64
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken: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

Typ:Int32
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-SkipEmptyArchive

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

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Status

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

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-StorageAccountResourceId

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

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-SubscriptionId

ID för målprenumerationen.

Typ:String
Position:Named
Standardvärde:(Get-AzContext).Subscription.Id
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken: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

Typ:Int32
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-UserAssignedIdentityId

Egenskaper för användartilldelade identiteter

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-WhatIf

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

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

IEventHubIdentity

Utdata

IEventhub