az iot hub distributed-tracing

Note

Esta referência faz parte da extensão azure-iot para o CLI do Azure (versão 2.70.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot hub distributed-tracing. Saiba mais sobre extensões.

Este grupo de comandos está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Gerencie configurações distribuídas por dispositivo.

Comandos

Name Descrição Tipo Estado
az iot hub distributed-tracing show

Obtenha as configurações de rastreamento distribuído para um dispositivo.

Extension Preview
az iot hub distributed-tracing update

Atualize as opções de rastreamento distribuído para um dispositivo.

Extension Preview

az iot hub distributed-tracing show

Pré-visualizar

O grupo de comandos 'iot hub distributed-tracing' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Obtenha as configurações de rastreamento distribuído para um dispositivo.

az iot hub distributed-tracing show --device-id
                                    --hub-name
                                    [--auth-type {key, login}]
                                    [--resource-group]

Exemplos

Obter as configurações de rastreamento distribuído para um dispositivo

az iot hub distributed-tracing show -d {device_id} -n {iothub_name}

Parâmetros Obrigatórios

--device-id -d

ID do dispositivo de destino.

--hub-name -n

Nome do Hub IoT ou nome de host. Obrigatório se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Valor predefinido: key
Valores aceites: key, login
--resource-group -g

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor predefinido: False

az iot hub distributed-tracing update

Pré-visualizar

O grupo de comandos 'iot hub distributed-tracing' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize as opções de rastreamento distribuído para um dispositivo.

az iot hub distributed-tracing update --device-id
                                      --hub-name
                                      --sampling-mode --sm {off, on}
                                      --sampling-rate --sr
                                      [--acquire-policy-token]
                                      [--auth-type {key, login}]
                                      [--change-reference]
                                      [--resource-group]

Exemplos

Atualizar as opções de rastreamento distribuído para um dispositivo

az iot hub distributed-tracing update -d {device_id} --sm on --sr 50 -n {iothub_name}

Parâmetros Obrigatórios

--device-id -d

ID do dispositivo de destino.

--hub-name -n

Nome do Hub IoT ou nome de host. Obrigatório se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--sampling-mode --sm

Ativa e desativa a amostragem para rastreamento distribuído. 1 está ligado e, 2 está desligado.

Propriedade Valor
Valores aceites: off, on
--sampling-rate --sr

Controla a quantidade de mensagens amostradas para adicionar contexto de rastreamento. Este valor é uma percentagem. Apenas valores de 0 a 100 (inclusive) são permitidos.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Valor predefinido: key
Valores aceites: key, login
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--resource-group -g

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor predefinido: False