Condividi tramite


Set-AzEventHub

Aggiorna un'entità EventHub

Sintassi

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>]

Descrizione

Aggiorna un'entità EventHub

Esempio

Esempio 1: Impostare l'acquisizione su un'entità EventHub esistente

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

Aggiorna l'entità myEventHub EventHub dallo spazio dei nomi myNamespace per abilitare l'acquisizione.

Esempio 2: Aggiornare l'entità EventHub eventhub usando il set di parametri 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

Aggiornamenti RetentionTimeInHour nell'entità myEventHub EventHub a 72 ore.

Parametri

-ArchiveNameFormat

Convenzione di denominazione BLOB per l'archivio, ad esempio {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. In questo caso tutti i parametri (Spazio dei nomi, Hub eventi e così via) sono obbligatori indipendentemente dall'ordine

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-AsJob

Eseguire il comando come processo

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-BlobContainer

Nome contenitore BLOB

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-CaptureEnabled

Valore che indica se la descrizione dell'acquisizione è abilitata.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Alias:cf
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-DefaultProfile

Le credenziali, l’account, il tenant e la sottoscrizione usati per comunicare con Azure.

Tipo:PSObject
Alias:AzureRMContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-DestinationName

Nome per la destinazione di acquisizione

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Encoding

Enumera i valori possibili per il formato di codifica della descrizione dell'acquisizione. Nota: 'AvroDeflate' sarà deprecato nella nuova versione dell'API

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-IdentityType

Tipo di identità del servizio gestito.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-InputObject

Parametro Identity. Per costruire, vedere la sezione NOTES per le proprietà INPUTOBJECT e creare una tabella hash.

Tipo:IEventHubIdentity
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-IntervalInSeconds

L'intervallo di tempo consente di impostare la frequenza con cui verrà eseguita l'acquisizione nei BLOB di Azure, il valore deve essere compreso tra 60 e 900 secondi

Tipo:Int32
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Name

Nome dell'entità EventHub.

Tipo:String
Alias:EventHubName
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-NamespaceName

Nome dello spazio dei nomi EventHub.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-NoWait

Eseguire il comando in modo asincrono

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-PartitionCount

Numero di partizioni create per l'hub eventi. I valori consentiti sono compresi tra 1 e 32 partizioni.

Tipo:Int64
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-ResourceGroupName

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-RetentionTimeInHour

Numero di ore per conservare gli eventi per l'hub eventi. Questo valore viene usato solo quando cleanupPolicy è Delete. Se cleanupPolicy è Compaction, il valore restituito di questa proprietà è Long.MaxValue

Tipo:Int64
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-SizeLimitInBytes

La finestra delle dimensioni definisce la quantità di dati compilati nell'hub eventi prima di un'operazione di acquisizione, il valore deve essere compreso tra 10485760 e 524288000 byte

Tipo:Int32
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-SkipEmptyArchive

Valore che indica se ignorare gli archivi vuoti

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Status

Enumera i valori possibili per lo stato dell'hub eventi.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-StorageAccountResourceId

ID risorsa dell'account di archiviazione da usare per creare i BLOB

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-SubscriptionId

ID della sottoscrizione di destinazione.

Tipo:String
Posizione:Named
Valore predefinito:(Get-AzContext).Subscription.Id
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-TombstoneRetentionTimeInHour

Numero di ore per conservare i marcatori di rimozione definitiva di un hub eventi compattato. Questo valore viene usato solo quando cleanupPolicy è Compaction. Il consumer deve completare la lettura del marcatore di rimozione definitiva entro questo periodo di tempo specificato se il consumer inizia dall'offset iniziale per assicurarsi di ottenere uno snapshot valido per la chiave specifica descritta dal marcatore di rimozione definitiva all'interno dell'hub eventi compattato

Tipo:Int32
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-UserAssignedIdentityId

Proprietà per le identità assegnate dall'utente

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

Tipo:SwitchParameter
Alias:wi
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

IEventHubIdentity

Output

IEventhub