Compartilhar via

az eventhubs eventhub

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

Comandos

Nome Description Tipo Status
az eventhubs eventhub authorization-rule

Regra de autorização do Eventhub.

 Core GA
az eventhubs eventhub authorization-rule create

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

 Core GA
az eventhubs eventhub authorization-rule delete

Excluir um AuthorizationRule do Hub de Eventos.

 Core GA
az eventhubs eventhub authorization-rule keys

Chaves de regra de autorização.

 Core GA
az eventhubs eventhub authorization-rule keys list

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

 Core GA
az eventhubs eventhub authorization-rule keys renew

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

 Core GA
az eventhubs eventhub authorization-rule list

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

 Core GA
az eventhubs eventhub authorization-rule show

Obtenha um AuthorizationRule para um Hub de Eventos por nome de regra.

 Core GA
az eventhubs eventhub authorization-rule update

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

 Core GA
az eventhubs eventhub consumer-group

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

 Core GA
az eventhubs eventhub consumer-group create

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

 Core GA
az eventhubs eventhub consumer-group delete

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

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

 Core GA
az eventhubs eventhub consumer-group show

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

 Core GA
az eventhubs eventhub consumer-group update

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

 Core GA
az eventhubs eventhub create

Cria o EventHubs Eventhub.

 Core GA
az eventhubs eventhub delete

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

 Core GA
az eventhubs eventhub list

Liste todos os Hubs de Eventos em um Namespace.

 Core GA
az eventhubs eventhub show

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

 Core GA
az eventhubs eventhub update

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

 Core GA

az eventhubs eventhub create

Editar

Cria o EventHubs Eventhub.

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]

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--archive-name-format

Convenção de nomenclatura de blob para arquivo morto, 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.

Propriedade Valor
Grupo de parâmetros: Capture-Destination Arguments
--blob-container

Nome do contêiner de blob.

Propriedade Valor
Grupo de parâmetros: Capture-Destination Arguments
--capture-interval

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

Propriedade Valor
Grupo de parâmetros: Capture Arguments
--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.

Propriedade Valor
Grupo de parâmetros: Capture Arguments
--cleanup-policy

Enumera os valores possíveis para a política de limpeza.

Propriedade Valor
Grupo de parâmetros: Retention-Description Arguments
Valores aceitos: Compact, Delete, DeleteOrCompact
--destination-name

O nome para o destino de captura deve ser EventHubArchive.AzureBlockBlob.

Propriedade Valor
Grupo de parâmetros: Capture-Destination Arguments
--enable-capture

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

Propriedade Valor
Grupo de parâmetros: Capture Arguments
Valores aceitos: false, true
--mi-system-assigned

Habilitar identidade atribuída pelo sistema.

Propriedade Valor
Grupo de parâmetros: Capture-Destination Arguments
Valor padrão: False
Valores aceitos: false, true
--mi-user-assigned

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

Propriedade Valor
Grupo de parâmetros: Capture-Destination Arguments
--min-compaction-lag-in-mins --min-lag

O tempo mínimo em que uma mensagem permanecerá inelegível para compactação no log. Esse valor é usado quando cleanupPolicy é Compact ou DeleteOrCompact.

Propriedade Valor
Grupo de parâmetros: Retention-Description Arguments
--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. Há suporte para o valor inferior de 1 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 Compaction, o valor retornado dessa propriedade será Long.MaxValue.

Propriedade Valor
Grupo de parâmetros: Retention-Description Arguments
--skip-empty-archives

Um valor booliano que indica se deve ignorar Vazio.

Propriedade Valor
Valores aceitos: false, true
--status

Status do Eventhub.

Propriedade Valor
Valores aceitos: Active, Disabled, SendDisabled
--storage-account

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

Propriedade Valor
Grupo de parâmetros: Capture-Destination Arguments
--timestamp-type

Denota o tipo de carimbo de data/hora que a mensagem conterá.

Propriedade Valor
Valores aceitos: Create, LogAppend
--tombstone-retention-time-in-hours --tombstone-time

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

Propriedade Valor
Grupo de parâmetros: Retention-Description Arguments
--user-metadata

Obtém e define metadados do usuário.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

O nome do Hub de Eventos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--namespace-name

O nome do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

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

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--skip

Skip só será usado se uma operação anterior retornar 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 aos N usageDetails mais recentes.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

O nome do Hub de Eventos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--namespace-name

O nome do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--add

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--archive-name-format

Convenção de nomenclatura de blob para arquivo morto, 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.

Propriedade Valor
Grupo de parâmetros: CaptureDescription Arguments
--blob-container

Nome do contêiner de blob.

Propriedade Valor
Grupo de parâmetros: CaptureDescription Arguments
--capture-interval

A janela de tempo permite definir a frequência com que a captura para Blobs do Azure ocorrerá, o valor deve entre 60 e 900 segundos.

Propriedade Valor
Grupo de parâmetros: CaptureDescription Arguments
--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.

Propriedade Valor
Grupo de parâmetros: CaptureDescription Arguments
--cleanup-policy

Enumera os valores possíveis para a política de limpeza.

Propriedade Valor
Grupo de parâmetros: RetentionDescription Arguments
Valores aceitos: Compact, Delete, DeleteOrCompact
--destination-name

Nome do destino da captura.

Propriedade Valor
Grupo de parâmetros: CaptureDescription Arguments
--enable-capture

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

Propriedade Valor
Grupo de parâmetros: CaptureDescription Arguments
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. Observação: 'AvroDeflate' será preterido na nova versão da API.

Propriedade Valor
Grupo de parâmetros: CaptureDescription Arguments
Valores aceitos: Avro, AvroDeflate
--event-hub-name --name -n

O nome do Hub de Eventos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
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 a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Destination Arguments
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--min-compaction-lag-in-mins --min-lag

O tempo mínimo em que uma mensagem permanecerá inelegível para compactação no log. Esse valor é usado quando cleanupPolicy é Compact ou DeleteOrCompact.

Propriedade Valor
Grupo de parâmetros: RetentionDescription Arguments
--namespace-name

O nome do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--partition-count

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

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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 Compaction, o valor retornado dessa propriedade será Long.MaxValue.

Propriedade Valor
Grupo de parâmetros: RetentionDescription Arguments
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--skip-empty-archives

Um valor que indica se ignorar arquivos vazios.

Propriedade Valor
Grupo de parâmetros: CaptureDescription Arguments
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.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
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.

Propriedade Valor
Grupo de parâmetros: CaptureDescription Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--timestamp-type

Denota o tipo de carimbo de data/hora que a mensagem conterá. Dois tipos de tipos de carimbo de data/hora : "AppendTime" e "CreateTime". AppendTime refere-se ao tempo em que a mensagem foi acrescentada dentro do log do agente. CreateTime refere-se ao tempo em que a mensagem foi gerada no lado da origem e os produtores podem definir esse carimbo de data/hora ao enviar a mensagem. O valor padrão é AppendTime. Se você estiver usando o protocolo AMQP, CreateTime será igual a AppendTime e seu comportamento permanecerá o mesmo.

Propriedade Valor
Grupo de parâmetros: MessageTimestampDescription Arguments
Valores aceitos: Create, LogAppend
--tombstone-retention-time-in-hours -t

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

Propriedade Valor
Grupo de parâmetros: RetentionDescription Arguments
--user-metadata

Obtém e define metadados do usuário.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False