az eventhubs eventhub

Gérer EventHubs EventHubs eventhub et règle d’autorisation.

Commandes

Nom	Description	Type	État
az eventhubs eventhub authorization-rule	Règle d’autorisation Eventhub.	Core	GA
az eventhubs eventhub authorization-rule create	Créez une authorizationRule pour le hub d’événements spécifié. La création/la mise à jour de AuthorizationRule prend quelques secondes.	Core	GA
az eventhubs eventhub authorization-rule delete	Supprimez une autorisation Event Hub AuthorizationRule.	Core	GA
az eventhubs eventhub authorization-rule keys	Authorization-rule keys.	Core	GA
az eventhubs eventhub authorization-rule keys list	Obtient les chaînes de connexion ACS et SAP pour event Hub.	Core	GA
az eventhubs eventhub authorization-rule keys renew	Régénère les chaînes de connexion ACS et SAP pour event Hub.	Core	GA
az eventhubs eventhub authorization-rule list	Répertoriez les règles d’autorisation d’un hub d’événements.	Core	GA
az eventhubs eventhub authorization-rule show	Obtenez une autorisationRule pour un hub d’événements par nom de règle.	Core	GA
az eventhubs eventhub authorization-rule update	Mettez à jour une autorisationRule pour le hub d’événements spécifié. La création/la mise à jour de AuthorizationRule prend quelques secondes.	Core	GA
az eventhubs eventhub consumer-group	Gérer le groupe de consommateurs Azure Event Hubs.	Core	GA
az eventhubs eventhub consumer-group create	Créez un groupe de consommateurs Event Hubs en tant que ressource imbriquée dans un espace de noms.	Core	GA
az eventhubs eventhub consumer-group delete	Supprimez un groupe de consommateurs du hub d’événements et du groupe de ressources spécifiés.	Core	GA
az eventhubs eventhub consumer-group list	Répertorier tous les groupes de consommateurs dans un espace de noms. Un flux vide est retourné si aucun groupe de consommateurs n’existe dans l’espace de noms.	Core	GA
az eventhubs eventhub consumer-group show	Obtenez une description pour le groupe de consommateurs spécifié.	Core	GA
az eventhubs eventhub consumer-group update	Mettez à jour un groupe de consommateurs Event Hubs en tant que ressource imbriquée dans un espace de noms.	Core	GA
az eventhubs eventhub create	Crée EventHubs EventHubs.	Core	GA
az eventhubs eventhub delete	Supprimez un Event Hub de l’espace de noms et du groupe de ressources spécifiés.	Core	GA
az eventhubs eventhub list	Répertorier tous les hubs d’événements dans un espace de noms.	Core	GA
az eventhubs eventhub show	Obtenez une description Event Hubs pour le hub d’événements spécifié.	Core	GA
az eventhubs eventhub update	Mettez à jour un hub d’événements en tant que ressource imbriquée dans un espace de noms.	Core	GA

az eventhubs eventhub create

Modifier

Crée EventHubs EventHubs.

az eventhubs eventhub create --name
                             --namespace-name
                             --resource-group
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {false, true}]
                             [--mi-system-assigned {false, true}]
                             [--mi-user-assigned]
                             [--min-compaction-lag-in-mins --min-lag]
                             [--partition-count]
                             [--retention-time --retention-time-in-hours]
                             [--skip-empty-archives {false, true}]
                             [--status {Active, Disabled, SendDisabled}]
                             [--storage-account]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours --tombstone-time]
                             [--user-metadata]

Exemples

Créez un eventhub.

az eventhubs eventhub create --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --cleanup-policy Delete --partition-count 15

Paramètres obligatoires

--name -n

Nom d’Eventhub.

--namespace-name

Nom de l’espace de noms.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--archive-name-format

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 (Namespace,EventHub .. etc) sont obligatoires, quel que soit l’ordre.

Propriété	Valeur
Parameter group:	Capture-Destination Arguments

--blob-container

Nom du conteneur d’objets blob.

Propriété	Valeur
Parameter group:	Capture-Destination Arguments

--capture-interval

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.

Propriété	Valeur
Parameter group:	Capture Arguments

--capture-size-limit

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.

Propriété	Valeur
Parameter group:	Capture Arguments

--cleanup-policy

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

Propriété	Valeur
Parameter group:	Retention-Description Arguments
Valeurs acceptées:	Compact, Delete, DeleteOrCompact

--destination-name

Le nom de la destination de capture doit être EventHubArchive.AzureBlockBlob.

Propriété	Valeur
Parameter group:	Capture-Destination Arguments

--enable-capture

Valeur booléenne qui indique si la capture est activée.

Propriété	Valeur
Parameter group:	Capture Arguments
Valeurs acceptées:	false, true

--mi-system-assigned

Activez l’identité affectée par le système.

Propriété	Valeur
Parameter group:	Capture-Destination Arguments
Valeur par défaut:	False
Valeurs acceptées:	false, true

--mi-user-assigned

Liste des ID d’identité attribués par l’utilisateur.

Propriété	Valeur
Parameter group:	Capture-Destination Arguments

--min-compaction-lag-in-mins --min-lag

La durée minimale pendant laquelle un message restera inéligible pour le compactage dans le journal. Cette valeur est utilisée lorsque cleanupPolicy est Compact ou DeleteOrCompact.

Propriété	Valeur
Parameter group:	Retention-Description Arguments

--partition-count

Nombre de partitions créées pour le hub d’événements. Par défaut, les valeurs autorisées sont 2 à 32. La valeur inférieure de 1 est prise en charge avec les espaces de noms kafka activés. En présence d’un quota personnalisé, la limite supérieure correspond à la limite supérieure du quota.

--retention-time --retention-time-in-hours

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 Compaction, la valeur retournée de cette propriété est Long.MaxValue.

Propriété	Valeur
Parameter group:	Retention-Description Arguments

--skip-empty-archives

Valeur booléenne qui indique s’il faut ignorer vide.

Propriété	Valeur
Valeurs acceptées:	false, true

--status

État d’Eventhub.

Propriété	Valeur
Valeurs acceptées:	Active, Disabled, SendDisabled

--storage-account

Nom (si dans le même groupe de ressources et non de type Stockage Classique) ou ID ARM du compte de stockage à utiliser pour créer les objets blob.

Propriété	Valeur
Parameter group:	Capture-Destination Arguments

--timestamp-type

Indique le type d’horodatage que le message contiendra.

Propriété	Valeur
Valeurs acceptées:	Create, LogAppend

--tombstone-retention-time-in-hours --tombstone-time

Nombre d’heures pour conserver les marqueurs tombstone d’un hub d’événements compacté. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Compaction. 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é.

Propriété	Valeur
Parameter group:	Retention-Description Arguments

--user-metadata

Obtient et définit les métadonnées de l’utilisateur.

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Output format.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété	Valeur
Valeur par défaut:	False

az eventhubs eventhub delete

Modifier

Supprimez un Event Hub de l’espace de noms et du groupe de ressources spécifiés.

az eventhubs eventhub delete [--event-hub-name --name]
                             [--ids]
                             [--namespace-name]
                             [--resource-group]
                             [--subscription]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name --name -n

Nom du hub d’événements.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--ids

Un ou plusieurs ID de ressource (délimités par l’espace). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

Propriété	Valeur
Parameter group:	Resource Id Arguments

--namespace-name

Nom de l’espace de noms.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété	Valeur
Parameter group:	Resource Id Arguments

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Output format.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété	Valeur
Valeur par défaut:	False

az eventhubs eventhub list

Modifier

Répertorier tous les hubs d’événements dans un espace de noms.

az eventhubs eventhub list --namespace-name
                           --resource-group
                           [--max-items]
                           [--next-token]
                           [--skip]
                           [--top]

Paramètres obligatoires

--namespace-name

Nom de l’espace de noms.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token argument d’une commande suivante.

Propriété	Valeur
Parameter group:	Pagination Arguments

--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

Propriété	Valeur
Parameter group:	Pagination Arguments

--skip

Ignorer n’est utilisé que si une opération précédente a retourné un résultat partiel. Si une réponse précédente contient un élément nextLink, la valeur de l’élément nextLink inclut un paramètre skip qui spécifie un point de départ à utiliser pour les appels suivants.

--top

Peut être utilisé pour limiter le nombre de résultats aux N usageDetails les plus récents.

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Output format.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété	Valeur
Valeur par défaut:	False

az eventhubs eventhub show

Modifier

Obtenez une description Event Hubs pour le hub d’événements spécifié.

az eventhubs eventhub show [--event-hub-name --name]
                           [--ids]
                           [--namespace-name]
                           [--resource-group]
                           [--subscription]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name --name -n

Nom du hub d’événements.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--ids

Propriété	Valeur
Parameter group:	Resource Id Arguments

--namespace-name

Nom de l’espace de noms.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété	Valeur
Parameter group:	Resource Id Arguments

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Output format.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété	Valeur
Valeur par défaut:	False

az eventhubs eventhub update

Modifier

Mettez à jour un hub d’événements en tant que ressource imbriquée dans un espace de noms.

az eventhubs eventhub update [--add]
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {0, 1, f, false, n, no, t, true, y, yes}]
                             [--encoding {Avro, AvroDeflate}]
                             [--event-hub-name --name]
                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                             [--identity]
                             [--ids]
                             [--min-compaction-lag-in-mins --min-lag]
                             [--namespace-name]
                             [--partition-count]
                             [--remove]
                             [--resource-group]
                             [--retention-time --retention-time-in-hours]
                             [--set]
                             [--skip-empty-archives {0, 1, f, false, n, no, t, true, y, yes}]
                             [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                             [--storage-account]
                             [--subscription]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours]
                             [--user-metadata]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string or JSON string>.

Propriété	Valeur
Parameter group:	Generic Update Arguments

--archive-name-format

Propriété	Valeur
Parameter group:	CaptureDescription Arguments

--blob-container

Nom du conteneur d’objets blob.

Propriété	Valeur
Parameter group:	CaptureDescription Arguments

--capture-interval

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

Propriété	Valeur
Parameter group:	CaptureDescription Arguments

--capture-size-limit

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.

Propriété	Valeur
Parameter group:	CaptureDescription Arguments

--cleanup-policy

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

Propriété	Valeur
Parameter group:	RetentionDescription Arguments
Valeurs acceptées:	Compact, Delete, DeleteOrCompact

--destination-name

Nom de la destination de capture.

Propriété	Valeur
Parameter group:	CaptureDescription Arguments

--enable-capture

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

Propriété	Valeur
Parameter group:	CaptureDescription Arguments
Valeurs acceptées:	0, 1, f, false, n, no, t, true, y, yes

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

Propriété	Valeur
Parameter group:	CaptureDescription Arguments
Valeurs acceptées:	Avro, AvroDeflate

--event-hub-name --name -n

Nom du hub d’événements.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

Propriété	Valeur
Parameter group:	Generic Update Arguments
Valeurs acceptées:	0, 1, f, false, n, no, t, true, y, yes

--identity

Valeur qui indique si la description de capture est activée. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Propriété	Valeur
Parameter group:	Destination Arguments

--ids

Propriété	Valeur
Parameter group:	Resource Id Arguments

--min-compaction-lag-in-mins --min-lag

La durée minimale pendant laquelle un message restera inéligible pour le compactage dans le journal. Cette valeur est utilisée lorsque cleanupPolicy est Compact ou DeleteOrCompact.

Propriété	Valeur
Parameter group:	RetentionDescription Arguments

--namespace-name

Nom de l’espace de noms.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--partition-count

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

Propriété	Valeur
Parameter group:	Properties Arguments

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriété	Valeur
Parameter group:	Generic Update Arguments

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--retention-time --retention-time-in-hours

Propriété	Valeur
Parameter group:	RetentionDescription Arguments

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=<value>.

Propriété	Valeur
Parameter group:	Generic Update Arguments

--skip-empty-archives

Valeur qui indique s’il faut ignorer les archives vides.

Propriété	Valeur
Parameter group:	CaptureDescription Arguments
Valeurs acceptées:	0, 1, f, false, n, no, t, true, y, yes

--status

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

Propriété	Valeur
Parameter group:	Properties Arguments
Valeurs acceptées:	Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown

--storage-account

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

Propriété	Valeur
Parameter group:	CaptureDescription Arguments

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Propriété	Valeur
Parameter group:	Resource Id Arguments

--timestamp-type

Indique le type d’horodatage que le message contiendra. Deux types d’horodatages : « AppendTime » et « CreateTime ». AppendTime fait référence à l’heure dans laquelle le message a été ajouté dans le journal broker. CreateTime fait référence à l’heure dans laquelle le message a été généré côté source et les producteurs peuvent définir cet horodatage lors de l’envoi du message. La valeur par défaut est AppendTime. Si vous utilisez le protocole AMQP, CreateTime est égal à AppendTime et son comportement reste le même.

Propriété	Valeur
Parameter group:	MessageTimestampDescription Arguments
Valeurs acceptées:	Create, LogAppend

--tombstone-retention-time-in-hours -t

Propriété	Valeur
Parameter group:	RetentionDescription Arguments

--user-metadata

Obtient et définit les métadonnées de l’utilisateur.

Propriété	Valeur
Parameter group:	Properties Arguments

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Output format.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété	Valeur
Valeur par défaut:	False

Partager via

az eventhubs eventhub

Commandes

az eventhubs eventhub create

Exemples

Paramètres obligatoires

Paramètres facultatifs

az eventhubs eventhub delete

Paramètres facultatifs

az eventhubs eventhub list

Paramètres obligatoires

Paramètres facultatifs

az eventhubs eventhub show

Paramètres facultatifs

az eventhubs eventhub update

Paramètres facultatifs

Commentaires