Compartilhar via


az iot hub message-enrichment

Observação

Esse grupo de comandos tem comandos definidos na CLI do Azure e em pelo menos uma extensão. Instale cada extensão para se beneficiar de seus recursos estendidos. Saiba mais sobre extensões.

Gerenciar enriquecimentos de mensagens para pontos de extremidade de um Hub IoT.

Comandos

Nome Description Tipo Status
az iot hub message-enrichment create

Crie um enriquecimento de mensagens para pontos de extremidade escolhidos em seu Hub IoT.

Core GA
az iot hub message-enrichment create (azure-iot extensão)

Crie um enriquecimento de mensagens para pontos de extremidade escolhidos em seu Hub IoT.

Extension GA
az iot hub message-enrichment delete

Exclua um enriquecimento de mensagens no hub IoT (por chave).

Core GA
az iot hub message-enrichment delete (azure-iot extensão)

Exclua um enriquecimento de mensagens no hub IoT (por chave).

Extension GA
az iot hub message-enrichment list

Obtenha informações sobre todos os enriquecimentos de mensagens para o Hub IoT.

Core GA
az iot hub message-enrichment list (azure-iot extensão)

Obtenha informações sobre todos os enriquecimentos de mensagens para o Hub IoT.

Extension GA
az iot hub message-enrichment update

Atualize um enriquecimento de mensagens no hub IoT (por chave).

Core GA
az iot hub message-enrichment update (azure-iot extensão)

Atualize um enriquecimento de mensagens no hub IoT (por chave).

Extension GA

az iot hub message-enrichment create

Crie um enriquecimento de mensagens para pontos de extremidade escolhidos em seu Hub IoT.

az iot hub message-enrichment create --endpoints
                                     --key
                                     --name
                                     --value
                                     [--resource-group]

Exemplos

Criar um enriquecimento de mensagem de {"key":"value"} para o ponto de extremidade "eventos" no Hub IoT

az iot hub message-enrichment create --key key --value value --endpoints events -n {iothub_name}

Parâmetros Exigidos

--endpoints -e

Pontos de extremidade aos quais aplicar enriquecimentos. Use uma lista separada por espaço para vários pontos de extremidade.

--key -k

A chave do enriquecimento.

--name -n

Nome do Hub IoT.

--value -v

O valor do enriquecimento.

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.

--resource-group -g

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

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 iot hub message-enrichment create (azure-iot extensão)

Crie um enriquecimento de mensagens para pontos de extremidade escolhidos em seu Hub IoT.

az iot hub message-enrichment create --endpoints
                                     --key
                                     --name
                                     --value
                                     [--resource-group]

Exemplos

Criar um enriquecimento de mensagem de {"key":"value"} para o ponto de extremidade "eventos" no Hub IoT

az iot hub message-enrichment create --key key --value value --endpoints events -n {iothub_name}

Parâmetros Exigidos

--endpoints -e

Pontos de extremidade aos quais aplicar enriquecimentos. Use uma lista separada por espaço para vários pontos de extremidade.

--key -k

A chave do enriquecimento.

--name -n

Nome do Hub IoT.

--value -v

O valor do enriquecimento.

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.

--resource-group -g

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

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 iot hub message-enrichment delete

Exclua um enriquecimento de mensagens no hub IoT (por chave).

az iot hub message-enrichment delete --key
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Exemplos

Excluir um enriquecimento de mensagens com a chave 'test' do Hub IoT

az iot hub message-enrichment delete --key test -n {iothub_name}

Parâmetros Exigidos

--key -k

A chave do enriquecimento.

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.

--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
--name -n

Nome do Hub IoT.

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 iot hub message-enrichment delete (azure-iot extensão)

Exclua um enriquecimento de mensagens no hub IoT (por chave).

az iot hub message-enrichment delete --key
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Exemplos

Excluir um enriquecimento de mensagens com a chave 'test' do Hub IoT

az iot hub message-enrichment delete --key test -n {iothub_name}

Parâmetros Exigidos

--key -k

A chave do enriquecimento.

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.

--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
--name -n

Nome do Hub IoT.

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 iot hub message-enrichment list

Obtenha informações sobre todos os enriquecimentos de mensagens para o Hub IoT.

az iot hub message-enrichment list [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

Exemplos

Listar todos os enriquecimentos de mensagens para o Hub IoT

az iot hub message-enrichment list -n {iothub_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.

--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
--name -n

Nome do Hub IoT.

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 iot hub message-enrichment list (azure-iot extensão)

Obtenha informações sobre todos os enriquecimentos de mensagens para o Hub IoT.

az iot hub message-enrichment list [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

Exemplos

Listar todos os enriquecimentos de mensagens para o Hub IoT

az iot hub message-enrichment list -n {iothub_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.

--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
--name -n

Nome do Hub IoT.

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 iot hub message-enrichment update

Atualize um enriquecimento de mensagens no hub IoT (por chave).

az iot hub message-enrichment update --endpoints
                                     --key
                                     --value
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Exemplos

Atualizar um enriquecimento de mensagens em seu hub IoT para aplicar a um novo conjunto de pontos de extremidade

az iot hub message-enrichment update --key {key} --value {value} --endpoints NewEndpoint1 NewEndpoint2 -n {iothub_name}

Parâmetros Exigidos

--endpoints -e

Pontos de extremidade aos quais aplicar enriquecimentos. Use uma lista separada por espaço para vários pontos de extremidade.

--key -k

A chave do enriquecimento.

--value -v

O valor do enriquecimento.

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.

--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
--name -n

Nome do Hub IoT.

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 iot hub message-enrichment update (azure-iot extensão)

Atualize um enriquecimento de mensagens no hub IoT (por chave).

az iot hub message-enrichment update --endpoints
                                     --key
                                     --value
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Exemplos

Atualizar um enriquecimento de mensagens em seu hub IoT para aplicar a um novo conjunto de pontos de extremidade

az iot hub message-enrichment update --key {key} --value {value} --endpoints NewEndpoint1 NewEndpoint2 -n {iothub_name}

Parâmetros Exigidos

--endpoints -e

Pontos de extremidade aos quais aplicar enriquecimentos. Use uma lista separada por espaço para vários pontos de extremidade.

--key -k

A chave do enriquecimento.

--value -v

O valor do enriquecimento.

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.

--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
--name -n

Nome do Hub IoT.

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