Partilhar via

az iot central device

  • Referência

Nota

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.46.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 IoT Central.

Comandos

Name 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 o atestado do 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 da nuvem para o 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 última solicitação de comando e resposta enviada ao dispositivo.

 Extensão GA
az iot central device command run

Execute um comando em um dispositivo e visualize a resposta associada. NÃO monitora 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

Gerencie dispositivos filhos de dispositivos IoT Edge.

 Extensão GA
az iot central device edge children add

Adicione dispositivos como crianças a um dispositivo de borda de destino.

 Extensão Pré-visualizar
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 Pré-visualizar
az iot central device edge manifest

Gerencie manifestos de dispositivos do IoT Edge.

 Extensão Pré-visualizar
az iot central device edge manifest show

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

 Extensão Pré-visualizar
az iot central device edge module

Gerencie módulos de dispositivo do IoT Edge.

 Extensão Pré-visualizar
az iot central device edge module list

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

 Extensão Pré-visualizar
az iot central device edge module restart

Reinicie um módulo em um dispositivo IoT Edge.

 Extensão Pré-visualizar
az iot central device edge module show

Obtenha um módulo em um dispositivo IoT Edge.

 Extensão Pré-visualizar
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

Liste os componentes presentes em um dispositivo.

 Extensão GA
az iot central device list-modules

Liste 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 ao Hub IoT original.

 Extensão GA
az iot central device manual-failover

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

 Extensão GA
az iot central device registration-info

Obtenha informações de registo no(s) dispositivo(s) a partir 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

Consulte 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 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

Atualize 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 de uma chave SAS no nível do grupo.

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

Exemplos

Utilização básica

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

Parâmetros Obrigatórios

--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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--app-id -n

A ID do aplicativo 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 diferencia maiúsculas de minúsculas (até 128 caracteres) de caracteres alfanuméricos ASCII de 7 bits mais certos caracteres especiais: - . + % _ # * ? ! ( ) , : = @ $ '.

Parâmetros Opcionais

--api-version --av
Preterido

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

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--device-name

Nome do dispositivo legível por humanos. Exemplo: Frigorífico.

--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 este sinalizador se quiser que o IoT Central o configure como um dispositivo simulado. --template é necessário se isso for verdade.

Valores aceites: false, true
Default value: False
--template

Exemplo: dtmi:ojpkindbz:modelDefinition:iild3tm_uo.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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

Eliminar um dispositivo

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--edge-only -e

Liste apenas dispositivos IoT Edge.

Default value: False
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az iot central device list-components

Liste 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 Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: 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ê pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az iot central device list-modules

Liste 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 Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 ao 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 ao Hub IoT original

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az iot central device manual-failover

Execute um failover manual de dispositivo em vários Hubs IoT para validar a capacidade do firmware do dispositivo de se reconectar usando 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 de dispositivo em vários Hubs IoT para validar a capacidade do firmware do dispositivo de se reconectar usando DPS a um Hub IoT diferente.

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 ao hub original. Tem valor padrão no back-end. Consulte a documentação sobre qual é o valor padrão de tempo de vida do back-end mais recentevisitando https://github.com/iot-for-all/iot-central-high-availability-clients#readme.

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az iot central device registration-info

Obtenha informações de registo no(s) dispositivo(s) a partir do IoT Central.

Observação: esse comando pode levar um tempo significativo para retornar se nenhum ID de dispositivo for especificado 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 Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az iot central device update

Atualize 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 do dispositivo

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

Transforme um dispositivo simulado em um 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}

Desativar um dispositivo

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

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo 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.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir 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 aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--device-name

Nome do dispositivo legível por humanos. Exemplo: Frigorífico.

--enable

Adicione este sinalizador se quiser que o IoT Central habilite ou desative o dispositivo.

Valores aceites: 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 este sinalizador se quiser que o IoT Central o configure como um dispositivo simulado. --template é necessário se isso for verdade.

Valores aceites: false, true
--template

Exemplo: dtmi:ojpkindbz:modelDefinition:iild3tm_uo.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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