Share via

az eventhubs eventhub

  • Referência

Gerenciar o hub de eventos e a regra de autorização do Azure EventHubs.

Comandos

Nome Description Tipo Status
az eventhubs eventhub authorization-rule

Regra de autorização do Eventhub.

 Núcleo GA
az eventhubs eventhub authorization-rule create

Crie uma AuthorizationRule para o Hub de Eventos especificado. A criação/atualização da AuthorizationRule levará alguns segundos para entrar em vigor.

 Núcleo GA
az eventhubs eventhub authorization-rule delete

Exclua uma Regra de Autorização do Hub de Eventos.

 Núcleo GA
az eventhubs eventhub authorization-rule keys

Chaves de regra de autorização.

 Núcleo GA
az eventhubs eventhub authorization-rule keys list

Obtém as cadeias de conexão ACS e SAS para o Hub de Eventos.

 Núcleo GA
az eventhubs eventhub authorization-rule keys renew

Regenera as cadeias de conexão ACS e SAS para o Hub de Eventos.

 Núcleo GA
az eventhubs eventhub authorization-rule list

Listar as regras de autorização para um Hub de Eventos.

 Núcleo GA
az eventhubs eventhub authorization-rule show

Obter uma AuthorizationRule para um Hub de Eventos por nome de regra.

 Núcleo GA
az eventhubs eventhub authorization-rule update

Atualize uma AuthorizationRule para o Hub de Eventos especificado. A criação/atualização da AuthorizationRule levará alguns segundos para entrar em vigor.

 Núcleo GA
az eventhubs eventhub consumer-group

Gerenciar o grupo de consumidores dos Hubs de Eventos do Azure.

 Núcleo GA
az eventhubs eventhub consumer-group create

Crie um grupo de consumidores de Hubs de Eventos como um recurso aninhado em um Namespace.

 Núcleo GA
az eventhubs eventhub consumer-group delete

Exclua um grupo de consumidores do Hub de Eventos e do grupo de recursos especificados.

 Núcleo GA
az eventhubs eventhub consumer-group list

Liste todos os grupos de consumidores em um namespace. Um feed vazio será retornado se nenhum grupo de consumidores existir no Namespace.

 Núcleo GA
az eventhubs eventhub consumer-group show

Obtenha uma descrição para o grupo de consumidores especificado.

 Núcleo GA
az eventhubs eventhub consumer-group update

Atualize um grupo de consumidores dos Hubs de Eventos como um recurso aninhado em um Namespace.

 Núcleo GA
az eventhubs eventhub create

Cria o EventHubs Eventhubs.

 Núcleo GA
az eventhubs eventhub delete

Exclua um Hub de Eventos do Namespace e do grupo de recursos especificados.

 Núcleo GA
az eventhubs eventhub list

Liste todos os Hubs de Eventos em um Namespace.

 Núcleo GA
az eventhubs eventhub show

Obtenha uma descrição dos Hubs de Eventos para o Hub de Eventos especificado.

 Núcleo GA
az eventhubs eventhub update

Atualize um novo Hub de Eventos como um recurso aninhado em um Namespace.

 Núcleo GA

az eventhubs eventhub create

Editar

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

Exemplos

Crie um novo Eventhub.

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

Parâmetros Exigidos

--name -n

Nome do Eventhub.

--namespace-name

Nome do namespace.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--archive-name-format

Convenção de nomenclatura de blob para arquivamento, por exemplo, {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Aqui todos os parâmetros (Namespace, EventHub, .. etc) são obrigatórios, independentemente da ordem.

--blob-container

Nome do contêiner de blob.

--capture-interval

Permite que você defina a frequência com que a captura para Blobs do Azure acontecerá, valor deve entre 60 a 900 segundos.

--capture-size-limit

Define a quantidade de dados acumulados no Hub de Eventos antes de uma operação de captura, o valor deve estar entre 10485760 a 524288000 bytes.

--cleanup-policy

Enumera os valores possíveis para a diretiva de limpeza.

valores aceitos: Compact, Delete
--destination-name

Nome para o destino de captura, deve ser EventHubArchive.AzureBlockBlob.

--enable-capture

Um valor booleano que indica se a captura está habilitada.

valores aceitos: false, true
--mi-system-assigned

Habilite a identidade atribuída ao sistema.

valores aceitos: false, true
valor padrão: False
--mi-user-assigned

Lista de IDs de identidade atribuídos pelo usuário.

--partition-count

Número de partições criadas para o Hub de Eventos. Por padrão, os valores permitidos são de 2 a 32. O valor mais baixo de 1 é suportado com namespaces habilitados para Kafka. Na presença de uma cota personalizada, o limite superior corresponderá ao limite superior da cota.

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

Número de horas para reter os eventos deste Hub de Eventos. Esse valor só é usado quando cleanupPolicy é Delete. Se cleanupPolicy for Compactação, o valor retornado dessa propriedade será Long.MaxValue.

--skip-empty-archives

Um valor booleano que indica se Ignorar vazio deve ser ignorado.

valores aceitos: false, true
--status

Status do Eventhub.

valores aceitos: Active, Disabled, SendDisabled
--storage-account

Nome (se estiver dentro do mesmo grupo de recursos e não do tipo Armazenamento Clássico) ou ID ARM da conta de armazenamento a ser usada para criar os blobs.

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

Número de horas para reter os marcadores de lápide de um Hub de Eventos compactado. Esse valor só é usado quando cleanupPolicy é Compaction. O consumidor deve concluir a leitura do marcador de lápide dentro desse período de tempo especificado se o consumidor começar a iniciar o deslocamento para garantir que ele obtenha um instantâneo válido para a chave específica descrita pelo marcador de marca de exclusão no Hub de Eventos compactado.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az eventhubs eventhub delete

Editar

Exclua um Hub de Eventos do Namespace e do grupo de recursos especificados.

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

Parâmetros Opcionais

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

O nome do Hub de Eventos.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--namespace-name

O nome do namespace.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az eventhubs eventhub list

Editar

Liste todos os Hubs de Eventos em um Namespace.

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

Parâmetros Exigidos

--namespace-name

O nome do namespace.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor de token de uma resposta truncada anteriormente.

--skip

Ignorar só será usado se uma operação anterior retornou um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skip que especifica um ponto de partida a ser usado para chamadas subsequentes.

--top

Pode ser usado para limitar o número de resultados ao N usageDetails mais recente.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az eventhubs eventhub show

Editar

Obtenha uma descrição dos Hubs de Eventos para o Hub de Eventos especificado.

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

Parâmetros Opcionais

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

O nome do Hub de Eventos.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--namespace-name

O nome do namespace.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az eventhubs eventhub update

Editar

Atualize um novo Hub de Eventos como um recurso aninhado em um Namespace.

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]

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string ou string> JSON.

--archive-name-format

Convenção de nomenclatura de blob para arquivamento, por exemplo, {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Aqui todos os parâmetros (Namespace, EventHub, .. etc) são obrigatórios, independentemente da ordem.

--blob-container

Nome do contêiner de blob.

--capture-interval

A janela de tempo permite que você defina a frequência com que a captura para Blobs do Azure acontecerá, valor deve entre 60 a 900 segundos.

--capture-size-limit

A janela de tamanho define a quantidade de dados acumulados no Hub de Eventos antes de uma operação de captura, o valor deve estar entre 10485760 a 524288000 bytes.

--cleanup-policy

Enumera os valores possíveis para a diretiva de limpeza.

valores aceitos: Compact, Delete
--destination-name

Nome para o destino de captura.

--enable-capture

Um valor que indica se a descrição da captura está habilitada.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--encoding

Enumera os valores possíveis para o formato de codificação da descrição da captura. Nota: 'AvroDeflate' será preterido na Nova Versão da API.

valores aceitos: Avro, AvroDeflate
--event-hub-name --name -n

O nome do Hub de Eventos.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--identity

Um valor que indica se a descrição da captura está habilitada. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--namespace-name

O nome do namespace.

--partition-count

Número de partições criadas para o Hub de Eventos, os valores permitidos são de 1 a 32 partições.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OU --remove propertyToRemove.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

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

Número de horas para reter os eventos deste Hub de Eventos. Esse valor só é usado quando cleanupPolicy é Delete. Se cleanupPolicy for Compact, o valor retornado dessa propriedade será Long.MaxValue.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=.

--skip-empty-archives

Um valor que indica se Ignorar arquivos vazios deve ser ignorado.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--status

Enumera os valores possíveis para o status do Hub de Eventos.

valores aceitos: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown
--storage-account

ID de recurso da conta de armazenamento a ser usada para criar os blobs.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

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

Número de horas para reter os marcadores de lápide de um Hub de Eventos compactado. Esse valor só é usado quando cleanupPolicy é Compact. O consumidor deve concluir a leitura do marcador de lápide dentro desse período de tempo especificado se o consumidor começar a iniciar o deslocamento para garantir que ele obtenha um instantâneo válido para a chave específica descrita pelo marcador de marca de exclusão no Hub de Eventos compactado.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.