az eventhubs eventhub

  • Référence

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

Commandes

Nom Description Type Statut
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

Clés de règle d’autorisation.

 Core GA
az eventhubs eventhub authorization-rule keys list

Obtient les chaîne de connexion ACS et SAP du hub d’événements.

 Core GA
az eventhubs eventhub authorization-rule keys renew

Régénère les chaîne de connexion ACS et SAS 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}]
                             [--destination-name]
                             [--enable-capture {false, true}]
                             [--mi-system-assigned {false, true}]
                             [--mi-user-assigned]
                             [--partition-count]
                             [--retention-time]
                             [--skip-empty-archives {false, true}]
                             [--status {Active, Disabled, SendDisabled}]
                             [--storage-account]
                             [--tombstone-retention-time-in-hours]

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 en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

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

--blob-container

Nom du conteneur d’objets blob.

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

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

--cleanup-policy

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

valeurs acceptées: Compact, Delete
--destination-name

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

--enable-capture

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

valeurs acceptées: false, true
--mi-system-assigned

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

valeurs acceptées: false, true
valeur par défaut: False
--mi-user-assigned

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

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

--skip-empty-archives

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

valeurs acceptées: false, true
--status

État d’Eventhub.

valeurs acceptées: Active, Disabled, SendDisabled
--storage-account

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

--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 propre upPolicy est Compaction. Le consommateur doit terminer la lecture du marqueur de pierre 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é.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

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]
                             [--ids]
                             [--namespace-name]
                             [--resource-group]
                             [--subscription]

Paramètres facultatifs

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

Nom du hub d’événements.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). 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 ».

--namespace-name

Nom de l’espace de noms.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

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

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

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 en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--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 l’argument d’une commande suivante.

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

--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 le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

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]
                           [--ids]
                           [--namespace-name]
                           [--resource-group]
                           [--subscription]

Paramètres facultatifs

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

Nom du hub d’événements.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). 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 ».

--namespace-name

Nom de l’espace de noms.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

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

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

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}]
                             [--destination-name]
                             [--enable-capture {0, 1, f, false, n, no, t, true, y, yes}]
                             [--encoding {Avro, AvroDeflate}]
                             [--event-hub-name]
                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                             [--identity]
                             [--ids]
                             [--namespace-name]
                             [--partition-count]
                             [--remove]
                             [--resource-group]
                             [--retention-time]
                             [--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]
                             [--tombstone-retention-time-in-hours]

Paramètres facultatifs

--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 ou JSON string>.

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

--blob-container

Nom du conteneur d’objets blob.

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

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

--cleanup-policy

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

valeurs acceptées: Compact, Delete
--destination-name

Nom de la destination de capture.

--enable-capture

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

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.

valeurs acceptées: Avro, AvroDeflate
--event-hub-name --name -n

Nom du hub d’événements.

--force-string

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

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.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). 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 ».

--namespace-name

Nom de l’espace de noms.

--partition-count

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

--remove

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

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--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 propre upPolicy est Delete. Si propre upPolicy est Compacter la valeur retournée de cette propriété est Long.MaxValue.

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

--skip-empty-archives

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

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.

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.

--subscription

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

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

Nombre d’heures pour conserver les marqueurs tombstone d’un hub d’événements compacté. Cette valeur est utilisée uniquement lorsque propre upPolicy est Compact. Le consommateur doit terminer la lecture du marqueur de pierre 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é.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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