New-AzEventHub

  • Référence
Module:
Az.EventHub

Créez un hub d’événements en tant que ressource imbriquée dans un espace de noms.

Syntaxe

New-AzEventHub
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-CaptureEnabled]
   [-CleanupPolicy <String>]
   [-DestinationName <String>]
   [-Encoding <String>]
   [-IdentityType <String>]
   [-IntervalInSeconds <Int32>]
   [-PartitionCount <Int64>]
   [-RetentionTimeInHour <Int64>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-Status <String>]
   [-StorageAccountResourceId <String>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-UserAssignedIdentityId <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventHub
   -Name <String>
   -NamespaceInputObject <IEventHubIdentity>
   [-ArchiveNameFormat <String>]
   [-BlobContainer <String>]
   [-CaptureEnabled]
   [-CleanupPolicy <String>]
   [-DestinationName <String>]
   [-Encoding <String>]
   [-IdentityType <String>]
   [-IntervalInSeconds <Int32>]
   [-PartitionCount <Int64>]
   [-RetentionTimeInHour <Int64>]
   [-SizeLimitInBytes <Int32>]
   [-SkipEmptyArchive]
   [-Status <String>]
   [-StorageAccountResourceId <String>]
   [-TombstoneRetentionTimeInHour <Int32>]
   [-UserAssignedIdentityId <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventHub
   -Name <String>
   -NamespaceInputObject <IEventHubIdentity>
   -Parameter <IEventhub>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Créez un hub d’événements en tant que ressource imbriquée dans un espace de noms.

Exemples

Exemple 1 : Créer une entité EventHub

New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -RetentionTimeInHour 168 -PartitionCount 5 -CleanupPolicy Delete

ArchiveNameFormat            :
BlobContainer                :
CaptureEnabled               :
CleanupPolicy                : Delete
CreatedAt                    : 4/25/2023 3:55:45 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     :
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds            :
Location                     : eastus
MessageRetentionInDay        : 7
Name                         : myEventHub
PartitionCount               : 5
PartitionId                  : {0, 1, 2, 3�}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          : 168
SizeLimitInBytes             :
SkipEmptyArchive             :
Status                       : Active
StorageAccountResourceId     :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type                         : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt                    : 4/25/2023 3:55:46 AM

Crée une entité myEventHub eventhub sur l’espace de noms myNamespace avec CleaupPolicy Delete.

Exemple 2 : Créer EventHub avec capture activée

New-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 -CleanupPolicy Delete"

ArchiveNameFormat            : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer                : container
CaptureEnabled               : true
CreatedAt                    : 9/1/2022 5:55:46 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     : Avro
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myFirstEventHub
IntervalInSeconds            : 600
Location                     : centralus
MessageRetentionInDays       : 6
Name                         : myFirstEventHub
PartitionCount               : 5
PartitionId                  : {0}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          : 24
SizeLimitInBytes             : 11000000
SkipEmptyArchive             : true
Status                       : Active

Crée une entité myEventHub eventhub sur l’espace de noms myNamespace avec la capture activée.

Exemple 3 : Créer une entité EventHub

New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -CleanupPolicy Compact

ArchiveNameFormat            :
BlobContainer                :
CaptureEnabled               :
CleanupPolicy                : Compact
CreatedAt                    : 4/25/2023 4:05:57 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     :
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds            :
Location                     : eastus
MessageRetentionInDay        : 9223372036854775807
Name                         : myEventHub
PartitionCount               : 4
PartitionId                  : {0, 1, 2, 3}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          :
SizeLimitInBytes             :
SkipEmptyArchive             :
Status                       : Active
StorageAccountResourceId     :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type                         : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt                    : 4/25/2023 4:05:58 AM

Crée une entité myEventHub eventhub sur l’espace de noms myNamespace avec CleaupPolicy Compact.

Paramètres

-ArchiveNameFormat

Convention d’affectation de noms d’objets blob pour l’archivage, par exemple {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Ici, tous les paramètres (Espace de noms,EventHub .. etc.) sont obligatoires, quel que soit l’ordre

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-BlobContainer

Nom du conteneur d’objets blob

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CaptureEnabled

Valeur qui indique si la description de capture est activée.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CleanupPolicy

Énumère les valeurs possibles pour la stratégie de nettoyage

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter la commande cmdlet.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Le paramètre DefaultProfile n’est pas fonctionnel. Utilisez le paramètre SubscriptionId lorsqu’il est disponible si vous exécutez l’applet de commande sur un autre abonnement.

Type:PSObject
Alias:AzureRMContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DestinationName

Nom de la destination de capture

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Encoding

Énumère les valeurs possibles pour le format d’encodage de la description de capture. Remarque : « AvroDeflate » sera déconseillé dans la nouvelle version de l’API

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IdentityType

Type d’identité managée Azure Active Directory.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IntervalInSeconds

La fenêtre de temps vous permet de définir la fréquence à laquelle la capture est effectuée sur les objets blob Azure, la valeur doit être comprise entre 60 et 900 secondes.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Name

Nom du hub d’événements

Type:String
Alias:EventHubName
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-NamespaceInputObject

Paramètre d’identité

Type:IEventHubIdentity
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-NamespaceName

Nom de l’espace de noms

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Parameter

Élément unique dans l’opération List ou Get Event Hub

Type:IEventhub
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-PartitionCount

Nombre de partitions créées pour le hub d’événements, les valeurs autorisées sont comprises entre 1 et 32 partitions.

Type:Int64
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ResourceGroupName

Nom du groupe de ressources dans l’abonnement Azure.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RetentionTimeInHour

Nombre d’heures de conservation des événements pour ce hub d’événements. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Delete. Si cleanupPolicy est Compacter la valeur retournée de cette propriété est Long.MaxValue

Type:Int64
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SizeLimitInBytes

La fenêtre de taille définit la quantité de données générées dans votre Event Hub avant une opération de capture, la valeur doit être comprise entre 10485760 et 524288000 octets

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SkipEmptyArchive

Valeur qui indique s’il faut ignorer les archives vides

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Status

Énumère les valeurs possibles pour l’état du hub d’événements.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-StorageAccountResourceId

ID de ressource du compte de stockage à utiliser pour créer les objets blob

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SubscriptionId

Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

Type:String
Position:Named
Valeur par défaut:(Get-AzContext).Subscription.Id
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-TombstoneRetentionTimeInHour

Nombre d’heures pour conserver les marqueurs tombstone d’un hub d’événements compacté. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Compact. Le consommateur doit terminer la lecture du marqueur tombstone dans ce délai spécifié si le consommateur commence à démarrer le décalage pour s’assurer qu’il obtient un instantané valide pour la clé spécifique décrite par le marqueur tombstone dans le hub d’événements compacté

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-UserAssignedIdentityId

ID ARM de l’identité utilisateur managée. Cette propriété est obligatoire est le type UserAssignedIdentity. Si le type est SystemAssigned, l’identité affectée par le système associée à l’espace de noms est utilisée.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

IEventhub

IEventHubIdentity

Sorties

IEventhub