Udostępnij przez

Set-AzEventHub

Moduł:
Az.EventHub Module

Aktualizuje jednostkę usługi EventHub

Składnia

SetExpanded (Domyślne) 

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

SetViaIdentityExpanded 

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

Opis

Aktualizuje jednostkę usługi EventHub

Przykłady

Przykład 1. Ustawianie przechwytywania w istniejącej jednostce usługi 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

Aktualizuje jednostkę myEventHub usługi EventHub z przestrzeni nazw myNamespace , aby umożliwić jej przechwytywanie.

Przykład 2. Aktualizowanie jednostki EventHub EventHub przy użyciu zestawu parametrów 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

Aktualizacje RetentionTimeInHour w jednostce myEventHub EventHub do 72 godzin.

Parametry

-ArchiveNameFormat

Konwencja nazewnictwa obiektów blob dla archiwum, np. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Tutaj wszystkie parametry (przestrzeń nazw, eventhub itp.) są obowiązkowe niezależnie od kolejności

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-AsJob

Uruchamianie polecenia jako zadania

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-BlobContainer

Nazwa kontenera obiektów blob

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-CaptureEnabled

Wartość wskazująca, czy opis przechwytywania jest włączony.

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False
Aliasy:por

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Właściwości parametrów

Typ:PSObject
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False
Aliasy:AzureRMContext, AzureCredential

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-DestinationName

Nazwa miejsca docelowego przechwytywania

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-Encoding

Wylicza możliwe wartości dla formatu kodowania opisu przechwytywania. Uwaga: "AvroDeflate" będzie przestarzała w nowej wersji interfejsu API

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-IdentityType

Typ tożsamości usługi zarządzanej.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-InputObject

Parametr tożsamości. Aby utworzyć tabelę, zobacz sekcję UWAGI dla właściwości INPUTOBJECT i utwórz tabelę skrótów.

Właściwości parametrów

Typ:IEventHubIdentity
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

SetViaIdentityExpanded
Pozycja:Named
Obowiązkowy:True
Wartość z pipeline:True
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-IntervalInSeconds

Przedział czasu umożliwia ustawienie częstotliwości, z jaką będzie wykonywane przechwytywanie obiektów blob platformy Azure. Wartość powinna wynosić od 60 do 900 sekund

Właściwości parametrów

Typ:Int32
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-MinCompactionLagInMin

Minimalny czas, przez który komunikat pozostanie niekwalifikowany do kompaktowania w dzienniku.

Właściwości parametrów

Typ:Int64
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-Name

Nazwa jednostki EventHub.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False
Aliasy:EventHubName

Zbiory parametrów

SetExpanded
Pozycja:Named
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-NamespaceName

Nazwa przestrzeni nazw usługi EventHub.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

SetExpanded
Pozycja:Named
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-NoWait

Uruchom polecenie asynchronicznie

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-PartitionCount

Liczba partycji utworzonych dla centrum zdarzeń. dozwolone wartości to od 1 do 32 partycji.

Właściwości parametrów

Typ:Int64
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-ResourceGroupName

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

SetExpanded
Pozycja:Named
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-RetentionTimeInHour

Liczba godzin przechowywania zdarzeń dla tego centrum zdarzeń. Ta wartość jest używana tylko wtedy, gdy funkcja cleanupPolicy to Delete. Jeśli cleanupPolicy to Compaction zwracana wartość tej właściwości to Long.MaxValue

Właściwości parametrów

Typ:Int64
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-SizeLimitInBytes

Okno rozmiaru definiuje ilość danych skompilowanych w centrum zdarzeń przed operacją przechwytywania, wartość powinna należeć między 10485760 do 524288000 bajtów

Właściwości parametrów

Typ:Int32
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-SkipEmptyArchive

Wartość wskazująca, czy pominąć puste archiwa

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-Status

Wylicza możliwe wartości stanu centrum zdarzeń.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-StorageAccountResourceId

Identyfikator zasobu konta magazynu do utworzenia obiektów blob

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-SubscriptionId

Identyfikator subskrypcji docelowej.

Właściwości parametrów

Typ:String
Wartość domyślna:(Get-AzContext).Subscription.Id
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

SetExpanded
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-TimestampType

Określa typ znacznika czasu, który będzie przechowywać komunikat.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-TombstoneRetentionTimeInHour

Liczba godzin przechowywania znaczników nagrobka skompaktowanego centrum zdarzeń. Ta wartość jest używana tylko wtedy, gdy cleanupPolicy to Compaction. Użytkownik musi ukończyć odczytywanie znacznika grobowca w określonym czasie, jeśli użytkownik rozpoczyna się od przesunięcia początkowego, aby upewnić się, że otrzyma prawidłową migawkę dla określonego klucza opisanego przez znacznik grobowca w skompaktowanym centrum zdarzeń

Właściwości parametrów

Typ:Int32
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-UserAssignedIdentityId

Właściwości tożsamości przypisanych przez użytkownika

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-UserMetadata

Pobiera i ustawia metadane użytkownika.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False
Aliasy:Wi

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Wejścia

IEventHubIdentity

Wyjść

IEventhub