Condividi tramite

az eventhubs eventhub

Gestire EventHubs di Azure EventHubs e la regola di autorizzazione.

Comandi

Nome Descrizione Tipo Status
az eventhubs eventhub authorization-rule

Regola di autorizzazione di EventHub.

 Core GA
az eventhubs eventhub authorization-rule create

Creare un oggetto AuthorizationRule per l'hub eventi specificato. La creazione/aggiornamento di AuthorizationRule richiederà alcuni secondi.

 Core GA
az eventhubs eventhub authorization-rule delete

Eliminare un'autorizzazione dell'hub eventiRule.

 Core GA
az eventhubs eventhub authorization-rule keys

Authorization-rule keys.

 Core GA
az eventhubs eventhub authorization-rule keys list

Ottiene le stringhe di connessione ACS e SAS per l'hub eventi.

 Core GA
az eventhubs eventhub authorization-rule keys renew

Rigenera le stringhe di connessione ACS e SAS per l'hub eventi.

 Core GA
az eventhubs eventhub authorization-rule list

Elencare le regole di autorizzazione per un hub eventi.

 Core GA
az eventhubs eventhub authorization-rule show

Ottenere authorizationRule per un hub eventi in base al nome della regola.

 Core GA
az eventhubs eventhub authorization-rule update

Aggiornare authorizationRule per l'hub eventi specificato. La creazione/aggiornamento di AuthorizationRule richiederà alcuni secondi.

 Core GA
az eventhubs eventhub consumer-group

Gestire il consumergroup di Hub eventi di Azure.

 Core GA
az eventhubs eventhub consumer-group create

Creare un gruppo di consumer di Hub eventi come risorsa annidata all'interno di uno spazio dei nomi.

 Core GA
az eventhubs eventhub consumer-group delete

Eliminare un gruppo di consumer dall'hub eventi e dal gruppo di risorse specificati.

 Core GA
az eventhubs eventhub consumer-group list

Elencare tutti i gruppi di consumer in uno spazio dei nomi. Se non esiste alcun gruppo di consumer nello spazio dei nomi, viene restituito un feed vuoto.

 Core GA
az eventhubs eventhub consumer-group show

Ottenere una descrizione per il gruppo di consumer specificato.

 Core GA
az eventhubs eventhub consumer-group update

Aggiornare un gruppo di consumer di Hub eventi come risorsa annidata all'interno di uno spazio dei nomi.

 Core GA
az eventhubs eventhub create

Crea EventHubs EventHubs.

 Core GA
az eventhubs eventhub delete

Eliminare un hub eventi dallo spazio dei nomi e dal gruppo di risorse specificati.

 Core GA
az eventhubs eventhub list

Elencare tutti gli hub eventi in uno spazio dei nomi.

 Core GA
az eventhubs eventhub show

Ottenere una descrizione di Hub eventi per l'hub eventi specificato.

 Core GA
az eventhubs eventhub update

Aggiornare un nuovo hub eventi come risorsa annidata all'interno di uno spazio dei nomi.

 Core GA

az eventhubs eventhub create

Modifica

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

Esempio

Creare un nuovo Hub eventi.

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

Parametri necessari

--name -n

Nome di Eventhub.

--namespace-name

Nome dello spazio dei nomi.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

Parametri facoltativi

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

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.

Proprietà Valore
Parameter group: Capture-Destination Arguments
--blob-container

Nome contenitore BLOB.

Proprietà Valore
Parameter group: Capture-Destination Arguments
--capture-interval

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.

Proprietà Valore
Parameter group: Capture Arguments
--capture-size-limit

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.

Proprietà Valore
Parameter group: Capture Arguments
--cleanup-policy

Enumera i valori possibili per i criteri di pulizia.

Proprietà Valore
Parameter group: Retention-Description Arguments
Valori accettati: Compact, Delete, DeleteOrCompact
--destination-name

Il nome per la destinazione di acquisizione deve essere EventHubArchive.AzureBlockBlob.

Proprietà Valore
Parameter group: Capture-Destination Arguments
--enable-capture

Valore booleano che indica se l'acquisizione è abilitata.

Proprietà Valore
Parameter group: Capture Arguments
Valori accettati: false, true
--mi-system-assigned

Abilitare l'identità assegnata dal sistema.

Proprietà Valore
Parameter group: Capture-Destination Arguments
Valore predefinito: False
Valori accettati: false, true
--mi-user-assigned

Elenco degli ID identità assegnati dall'utente.

Proprietà Valore
Parameter group: Capture-Destination Arguments
--min-compaction-lag-in-mins --min-lag

Il tempo minimo per cui un messaggio rimarrà ineleggibile per la compattazione nel log. Questo valore viene usato quando cleanupPolicy è Compact o DeleteOrCompact.

Proprietà Valore
Parameter group: Retention-Description Arguments
--partition-count

Numero di partizioni create per l'hub eventi. Per impostazione predefinita, i valori consentiti sono 2-32. Il valore inferiore di 1 è supportato con gli spazi dei nomi abilitati per Kafka. In presenza di una quota personalizzata, il limite superiore corrisponderà al limite superiore della quota.

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

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.

Proprietà Valore
Parameter group: Retention-Description Arguments
--skip-empty-archives

Valore booleano che indica se ignorare vuoto.

Proprietà Valore
Valori accettati: false, true
--status

Stato di Eventhub.

Proprietà Valore
Valori accettati: Active, Disabled, SendDisabled
--storage-account

Nome (se all'interno dello stesso gruppo di risorse e non di tipo Archiviazione classica) o ID ARM dell'account di archiviazione da usare per creare i BLOB.

Proprietà Valore
Parameter group: Capture-Destination Arguments
--timestamp-type

Indica il tipo di timestamp che il messaggio conterrà.

Proprietà Valore
Valori accettati: Create, LogAppend
--tombstone-retention-time-in-hours --tombstone-time

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.

Proprietà Valore
Parameter group: Retention-Description Arguments
--user-metadata

Ottiene e imposta i metadati dell'utente.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Output format.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az eventhubs eventhub delete

Modifica

Eliminare un hub eventi dallo spazio dei nomi e dal gruppo di risorse specificati.

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

Parametri facoltativi

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

Nome dell'hub eventi.

Proprietà Valore
Parameter group: Resource Id Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Parameter group: Resource Id Arguments
--namespace-name

Nome dello spazio dei nomi.

Proprietà Valore
Parameter group: Resource Id Arguments
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

Proprietà Valore
Parameter group: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

Proprietà Valore
Parameter group: Resource Id Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Output format.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az eventhubs eventhub list

Modifica

Elencare tutti gli hub eventi in uno spazio dei nomi.

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

Parametri necessari

--namespace-name

Nome dello spazio dei nomi.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

Parametri facoltativi

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

--max-items

Numero totale di elementi da restituire nell'output del comando. Se il numero totale di elementi disponibili è maggiore del valore specificato, nell'output del comando viene fornito un token. Per riprendere la paginazione, specificare il valore del token in --next-token argomento di un comando successivo.

Proprietà Valore
Parameter group: Pagination Arguments
--next-token

Token per specificare dove iniziare la paginazione. Si tratta del valore del token di una risposta troncata in precedenza.

Proprietà Valore
Parameter group: Pagination Arguments
--skip

Skip viene utilizzato solo se un'operazione precedente ha restituito un risultato parziale. Se una risposta precedente contiene un elemento nextLink, il valore dell'elemento nextLink includerà un parametro skip che specifica un punto di partenza da utilizzare per le chiamate successive.

--top

Può essere usato per limitare il numero di risultati agli ultimi N usageDetails.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Output format.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az eventhubs eventhub show

Modifica

Ottenere una descrizione di Hub eventi per l'hub eventi specificato.

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

Parametri facoltativi

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

Nome dell'hub eventi.

Proprietà Valore
Parameter group: Resource Id Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Parameter group: Resource Id Arguments
--namespace-name

Nome dello spazio dei nomi.

Proprietà Valore
Parameter group: Resource Id Arguments
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

Proprietà Valore
Parameter group: Resource Id Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

Proprietà Valore
Parameter group: Resource Id Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Output format.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az eventhubs eventhub update

Modifica

Aggiornare un nuovo hub eventi come risorsa annidata all'interno di uno spazio dei nomi.

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]

Parametri facoltativi

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

--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, string or JSON string>.

Proprietà Valore
Parameter group: Generic Update Arguments
--archive-name-format

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.

Proprietà Valore
Parameter group: CaptureDescription Arguments
--blob-container

Nome contenitore BLOB.

Proprietà Valore
Parameter group: CaptureDescription Arguments
--capture-interval

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.

Proprietà Valore
Parameter group: CaptureDescription Arguments
--capture-size-limit

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.

Proprietà Valore
Parameter group: CaptureDescription Arguments
--cleanup-policy

Enumera i valori possibili per i criteri di pulizia.

Proprietà Valore
Parameter group: RetentionDescription Arguments
Valori accettati: Compact, Delete, DeleteOrCompact
--destination-name

Nome per la destinazione di acquisizione.

Proprietà Valore
Parameter group: CaptureDescription Arguments
--enable-capture

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

Proprietà Valore
Parameter group: CaptureDescription Arguments
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--encoding

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

Proprietà Valore
Parameter group: CaptureDescription Arguments
Valori accettati: Avro, AvroDeflate
--event-hub-name --name -n

Nome dell'hub eventi.

Proprietà Valore
Parameter group: Resource Id Arguments
--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

Proprietà Valore
Parameter group: Generic Update Arguments
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--identity

Valore che indica se la descrizione dell'acquisizione è abilitata. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più.

Proprietà Valore
Parameter group: Destination Arguments
--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà Valore
Parameter group: Resource Id Arguments
--min-compaction-lag-in-mins --min-lag

Il tempo minimo per cui un messaggio rimarrà ineleggibile per la compattazione nel log. Questo valore viene usato quando cleanupPolicy è Compact o DeleteOrCompact.

Proprietà Valore
Parameter group: RetentionDescription Arguments
--namespace-name

Nome dello spazio dei nomi.

Proprietà Valore
Parameter group: Resource Id Arguments
--partition-count

Il numero di partizioni create per l'hub eventi, i valori consentiti sono compresi tra 1 e 32 partizioni.

Proprietà Valore
Parameter group: Properties Arguments
--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Proprietà Valore
Parameter group: Generic Update Arguments
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

Proprietà Valore
Parameter group: Resource Id Arguments
--retention-time --retention-time-in-hours

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.

Proprietà Valore
Parameter group: RetentionDescription Arguments
--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>.

Proprietà Valore
Parameter group: Generic Update Arguments
--skip-empty-archives

Valore che indica se ignorare gli archivi vuoti.

Proprietà Valore
Parameter group: CaptureDescription Arguments
Valori accettati: 0, 1, f, false, n, no, t, true, y, yes
--status

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

Proprietà Valore
Parameter group: Properties Arguments
Valori accettati: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown
--storage-account

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

Proprietà Valore
Parameter group: CaptureDescription Arguments
--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

Proprietà Valore
Parameter group: Resource Id Arguments
--timestamp-type

Indica il tipo di timestamp che il messaggio conterrà. Due tipi di timestamp: "AppendTime" e "CreateTime". AppendTime fa riferimento all'ora in cui il messaggio è stato accodato all'interno del log broker. CreateTime fa riferimento all'ora in cui il messaggio è stato generato sul lato origine e i producer possono impostare questo timestamp durante l'invio del messaggio. Il valore predefinito è AppendTime. Se si usa il protocollo AMQP, CreateTime è uguale a AppendTime e il relativo comportamento rimane invariato.

Proprietà Valore
Parameter group: MessageTimestampDescription Arguments
Valori accettati: Create, LogAppend
--tombstone-retention-time-in-hours -t

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.

Proprietà Valore
Parameter group: RetentionDescription Arguments
--user-metadata

Ottiene e imposta i metadati dell'utente.

Proprietà Valore
Parameter group: Properties Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Output format.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False