az iot central device

Observação

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

Gerencie e configure dispositivos do IoT Central.

Comandos

Nome Description Tipo Status
az iot central device attestation

Gerencie e configure o atestado de dispositivo do IoT Central.

Extensão GA
az iot central device attestation create

Crie um atestado de dispositivo individual.

Extensão GA
az iot central device attestation delete

Remova um atestado de dispositivo individual.

Extensão GA
az iot central device attestation show

Obtenha atestado de dispositivo.

Extensão GA
az iot central device attestation update

Atualize um atestado de dispositivo individual via patch.

Extensão GA
az iot central device c2d-message

Execute comandos de mensagens de nuvem para dispositivo do dispositivo.

Extensão GA
az iot central device c2d-message purge

Limpa a fila de mensagens da nuvem para o dispositivo de destino.

Extensão GA
az iot central device command

Execute comandos de dispositivo.

Extensão GA
az iot central device command history

Obtenha os detalhes da solicitação de comando e resposta mais recentes enviadas ao dispositivo.

Extensão GA
az iot central device command run

Execute um comando em um dispositivo e exiba a resposta associada. NÃO monitora as atualizações de propriedade que o comando pode executar.

Extensão GA
az iot central device compute-device-key

Gere uma chave SAS de dispositivo derivada.

Extensão GA
az iot central device create

Crie um dispositivo no IoT Central.

Extensão GA
az iot central device delete

Exclua um dispositivo do IoT Central.

Extensão GA
az iot central device edge

Gerencie e configure dispositivos de borda do IoT Central.

Extensão GA
az iot central device edge children

Gerenciar dispositivos filhos do IoT Edge.

Extensão GA
az iot central device edge children add

Adicione dispositivos como filhos a um dispositivo de borda de destino.

Extensão Versão Prévia
az iot central device edge children list

Obtenha a lista de filhos de um dispositivo IoT Edge.

Extensão GA
az iot central device edge children remove

Remova dispositivos filho de um dispositivo de borda de destino.

Extensão Versão Prévia
az iot central device edge manifest

Gerenciar manifestos de dispositivo do IoT Edge.

Extensão Versão Prévia
az iot central device edge manifest show

Obtenha o manifesto de implantação associado ao dispositivo IoT Edge especificado.

Extensão Versão Prévia
az iot central device edge module

Gerenciar módulos de dispositivos do IoT Edge.

Extensão Versão Prévia
az iot central device edge module list

Obtenha a lista de módulos em um dispositivo IoT Edge.

Extensão Versão Prévia
az iot central device edge module restart

Reinicie um módulo em um dispositivo IoT Edge.

Extensão Versão Prévia
az iot central device edge module show

Obtenha um módulo em um dispositivo IoT Edge.

Extensão Versão Prévia
az iot central device list

Obtenha a lista de dispositivos para um aplicativo do IoT Central.

Extensão GA
az iot central device list-components

Listar os componentes presentes em um dispositivo.

Extensão GA
az iot central device list-modules

Listar os módulos presentes em um dispositivo.

Extensão GA
az iot central device manual-failback

Reverte o comando de failover executado anteriormente movendo o dispositivo de volta para o Hub IoT original.

Extensão GA
az iot central device manual-failover

Execute um failover manual do dispositivo em vários Hubs IoT para validar a capacidade do firmware do dispositivo de se reconectar usando o DPS a um Hub IoT diferente.

Extensão GA
az iot central device registration-info

Obtenha informações de registro no(s) dispositivo(s) do IoT Central.

Extensão GA
az iot central device show

Obtenha um dispositivo do IoT Central.

Extensão GA
az iot central device show-credentials

Obtenha credenciais de dispositivo do IoT Central.

Extensão GA
az iot central device telemetry

Consultar o último valor de telemetria do dispositivo IoT Central.

Extensão GA
az iot central device telemetry show

Obtenha o último valor de telemetria de um dispositivo.

Extensão GA
az iot central device twin

Gerencie gêmeos de dispositivos do IoT Central.

Extensão GA
az iot central device twin replace

Substitua os valores de propriedade graváveis de um dispositivo, um componente de dispositivo ou um módulo de dispositivo ou um componente de módulo de dispositivo.

Extensão GA
az iot central device twin show

Obtenha todos os valores de propriedade de um dispositivo, um componente de dispositivo, um módulo de dispositivo ou um componente de módulo de dispositivo.

Extensão GA
az iot central device twin update

Atualize os valores de propriedade graváveis de um dispositivo, um componente de dispositivo, um módulo de dispositivo ou um componente de módulo de dispositivo.

Extensão GA
az iot central device update

Atualizar um dispositivo no IoT Central.

Extensão GA

az iot central device compute-device-key

Gere uma chave SAS de dispositivo derivada.

Gere uma chave de dispositivo derivada a partir de uma chave SAS de nível de grupo.

az iot central device compute-device-key --device-id
                                         --pk

Exemplos

Uso básico

az iot central device compute-device-key --pk {primaryKey} --device-id {deviceid}

Parâmetros Exigidos

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

--pk --primary-key

A chave de acesso compartilhada simétrica primária armazenada no formato base64.

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 iot central device create

Crie um dispositivo no IoT Central.

az iot central device create --app-id
                             --device-id
                             [--api-version {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri]
                             [--device-name]
                             [--organizations]
                             [--simulated {false, true}]
                             [--template]
                             [--token]

Exemplos

criar um dispositivo;

az iot central device create --app-id {appid} --device-id {deviceid}

Criar um dispositivo simulado

az iot central device create --app-id {appid} --device-id {deviceid} --template {devicetemplateid} --simulated

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

Identificador exclusivo do dispositivo. Uma cadeia de caracteres que não diferencia maiúsculas de minúsculas (de até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits mais alguns caracteres especiais: – . + % _ # * ? ! ( ) , : = @ $ '.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--device-name

Nome do dispositivo legível por humanos. Exemplo: Geladeira.

--organizations --orgs

Atribua o dispositivo às organizações especificadas. Lista separada por vírgulas de ids da organização. Versão mínima suportada: 1.1-preview.

--simulated

Adicione esse sinalizador se quiser que o IoT Central o configure como um dispositivo simulado. --template é necessário se isso for verdade.

valores aceitos: false, true
valor padrão: False
--template

Exemplo de dtmi:ojpkindbz:modelDefinition:iild3tm_uo.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 iot central device delete

Exclua um dispositivo do IoT Central.

az iot central device delete --app-id
                             --device-id
                             [--api-version {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri]
                             [--token]

Exemplos

Excluir um dispositivo

az iot central device delete --app-id {appid} --device-id {deviceid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 iot central device list

Obtenha a lista de dispositivos para um aplicativo do IoT Central.

az iot central device list --app-id
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--edge-only]
                           [--token]

Exemplos

Listar todos os dispositivos em um aplicativo, classificados por ID do dispositivo (padrão)

az iot central device list --app-id {appid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--edge-only -e

Liste apenas dispositivos IoT Edge.

valor padrão: False
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 iot central device list-components

Listar os componentes presentes em um dispositivo.

az iot central device list-components --app-id
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--mn]
                                      [--token]

Exemplos

Listar os componentes presentes em um dispositivo

az iot central device list-components --app-id {appid} --device-id {deviceid}

Listar os componentes presentes em um módulo de dispositivo

az iot central device list-components --app-id {appid} --module-name {modulename} --device-id {deviceid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--mn --module-name

O nome do módulo do dispositivo.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 iot central device list-modules

Listar os módulos presentes em um dispositivo.

az iot central device list-modules --app-id
                                   --device-id
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--token]

Exemplos

Listar os módulos presentes em um dispositivo

az iot central device list-modules --app-id {appid} --device-id {deviceid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 iot central device manual-failback

Reverte o comando de failover executado anteriormente movendo o dispositivo de volta para o Hub IoT original.

Para obter mais informações sobre alta disponibilidade, visite https://github.com/iot-for-all/iot-central-high-availability-clients#readme.

az iot central device manual-failback --app-id
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Exemplos

Reverte o comando de failover executado anteriormente movendo o dispositivo de volta para o Hub IoT original

az iot central device manual-failback --app-id {appid} --device-id {deviceid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 iot central device manual-failover

Execute um failover manual do dispositivo em vários Hubs IoT para validar a capacidade do firmware do dispositivo de se reconectar usando o DPS a um Hub IoT diferente.

Para obter mais informações sobre alta disponibilidade e valor padrão para ttl-minutes, visite https://github.com/iot-for-all/iot-central-high-availability-clients#readme.

az iot central device manual-failover --app-id
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]
                                      [--ttl]

Exemplos

Execute um failover manual do dispositivo em vários Hubs IoT para validar a capacidade do firmware do dispositivo de se reconectar usando o DPS a um Hub IoT diferente.

az iot central device manual-failover --app-id {appid} --device-id {deviceid} --ttl-minutes {ttl_minutes}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

--ttl --ttl-minutes

Um número inteiro positivo. TTL em minutos para mover o dispositivo de volta para o hub original. Tem valor padrão no back-end. Consulte a documentação sobre qual é o valor de tempo de vida padrão do back-end mais recente visitando https://github.com/iot-for-all/iot-central-high-availability-clients#readme.

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 iot central device registration-info

Obtenha informações de registro no(s) dispositivo(s) do IoT Central.

Observação: esse comando pode levar uma quantidade significativa de tempo para retornar se nenhuma ID de dispositivo for especificada e seu aplicativo contiver muitos dispositivos.

az iot central device registration-info --app-id
                                        --device-id
                                        [--api-version {2022-06-30-preview, 2022-07-31}]
                                        [--central-api-uri]
                                        [--token]

Exemplos

Obter informações de registro no dispositivo especificado

az iot central device registration-info --app-id {appid} --device-id {deviceid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 iot central device show

Obtenha um dispositivo do IoT Central.

az iot central device show --app-id
                           --device-id
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--token]

Exemplos

Obter um dispositivo

az iot central device show --app-id {appid} --device-id {deviceid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 iot central device show-credentials

Obtenha credenciais de dispositivo do IoT Central.

az iot central device show-credentials --app-id
                                       --device-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

Exemplos

Obter credenciais de dispositivo para um dispositivo

az iot central device show-credentials --app-id {appid} --device-id {deviceid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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 iot central device update

Atualizar um dispositivo no IoT Central.

Permite alterar as seguintes propriedades de um dispositivo: "displayName", "template", "simulated", "enabled" e "organizations". A ID do dispositivo não pode ser alterada.

az iot central device update --app-id
                             --device-id
                             [--api-version {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri]
                             [--device-name]
                             [--enable {false, true}]
                             [--organizations]
                             [--simulated {false, true}]
                             [--template]
                             [--token]

Exemplos

Atualizar um nome de exibição de dispositivo

az iot central device update --app-id {appid} --device-id {deviceid} --device-name {deviceName}

Transforme um dispositivo simulado em um dispositivo real

az iot central device update --app-id {appid} --device-id {deviceid} --simulated false

Atualizar organizações para o dispositivo

az iot central device update --app-id {appid} --device-id {deviceid} --organizations {organizations}

Desabilitar um dispositivo

az iot central device update --app-id {appid} --device-id {deviceid} --enable false

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--device-id -d

O ID do dispositivo de destino. Você pode encontrar o ID do dispositivo clicando no botão Conectar na página Detalhes do dispositivo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

valores aceitos: 2022-06-30-preview, 2022-07-31
valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--device-name

Nome do dispositivo legível por humanos. Exemplo: Geladeira.

--enable

Adicione esse sinalizador se quiser que o IoT Central habilite ou desabilite o dispositivo.

valores aceitos: false, true
--organizations --orgs

Atribua o dispositivo às organizações especificadas. Lista separada por vírgulas de ids da organização. Versão mínima suportada: 1.1-preview.

--simulated

Adicione esse sinalizador se quiser que o IoT Central o configure como um dispositivo simulado. --template é necessário se isso for verdade.

valores aceitos: false, true
--template

Exemplo de dtmi:ojpkindbz:modelDefinition:iild3tm_uo.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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.