az iot central device
Note
Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.67.0 ou superior). A extensão instalará 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. |
Extension | GA |
| az iot central device attestation create |
Crie um atestado de dispositivo individual. |
Extension | GA |
| az iot central device attestation delete |
Remova um atestado de dispositivo individual. |
Extension | GA |
| az iot central device attestation show |
Obtenha o atestado do dispositivo. |
Extension | GA |
| az iot central device attestation update |
Atualize um atestado de dispositivo individual por meio de patch. |
Extension | GA |
| az iot central device c2d-message |
Execute comandos de mensagens da nuvem para o dispositivo do dispositivo. |
Extension | GA |
| az iot central device c2d-message purge |
Limpa a fila de mensagens da nuvem para o dispositivo para o dispositivo de destino. |
Extension | GA |
| az iot central device command |
Execute comandos do dispositivo. |
Extension | GA |
| az iot central device command history |
Obtenha os detalhes da solicitação de comando e da resposta mais recentes enviadas ao dispositivo. |
Extension | 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. |
Extension | GA |
| az iot central device compute-device-key |
Gere uma chave SAS do dispositivo derivado. |
Extension | GA |
| az iot central device create |
Crie um dispositivo no IoT Central. |
Extension | GA |
| az iot central device delete |
Exclua um dispositivo do IoT Central. |
Extension | GA |
| az iot central device edge |
Gerencie e configure dispositivos de borda do IoT Central. |
Extension | GA |
| az iot central device edge children |
Gerencie dispositivos filhos de dispositivos IoT Edge. |
Extension | GA |
| az iot central device edge children add |
Adicione dispositivos como filhos a um dispositivo de borda de destino. |
Extension | Preview |
| az iot central device edge children list |
Obtenha a lista de filhos de um dispositivo IoT Edge. |
Extension | GA |
| az iot central device edge children remove |
Remova dispositivos filhos de um dispositivo de borda de destino. |
Extension | Preview |
| az iot central device edge manifest |
Gerencie manifestos de dispositivo do IoT Edge. |
Extension | Preview |
| az iot central device edge manifest show |
Obtenha o manifesto de implantação associado ao dispositivo IoT Edge especificado. |
Extension | Preview |
| az iot central device edge module |
Gerencie módulos de dispositivo IoT Edge. |
Extension | Preview |
| az iot central device edge module list |
Obtenha a lista de módulos em um dispositivo IoT Edge. |
Extension | Preview |
| az iot central device edge module restart |
Reinicie um módulo em um dispositivo IoT Edge. |
Extension | Preview |
| az iot central device edge module show |
Obtenha um módulo em um dispositivo IoT Edge. |
Extension | Preview |
| az iot central device list |
Obtenha a lista de dispositivos para um aplicativo do IoT Central. |
Extension | GA |
| az iot central device list-components |
Liste os componentes presentes em um dispositivo. |
Extension | GA |
| az iot central device list-modules |
Liste os módulos presentes em um dispositivo. |
Extension | GA |
| az iot central device manual-failback |
Reverte o comando de failover executado anteriormente movendo o dispositivo de volta para o Hub IoT original. |
Extension | 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. |
Extension | GA |
| az iot central device registration-info |
Obtenha informações de registro em dispositivos do IoT Central. |
Extension | GA |
| az iot central device show |
Obtenha um dispositivo do IoT Central. |
Extension | GA |
| az iot central device show-credentials |
Obtenha credenciais de dispositivo do IoT Central. |
Extension | GA |
| az iot central device telemetry |
Consulte o último valor de telemetria do dispositivo IoT Central. |
Extension | GA |
| az iot central device telemetry show |
Obtenha o último valor de telemetria de um dispositivo. |
Extension | GA |
| az iot central device twin |
Gerencie dispositivos gêmeos do IoT Central. |
Extension | 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. |
Extension | 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. |
Extension | GA |
| az iot central device twin update |
Atualize os valores de propriedade graváveis de um dispositivo, um componente do dispositivo, um módulo do dispositivo ou um componente do módulo do dispositivo. |
Extension | GA |
| az iot central device update |
Atualize um dispositivo no IoT Central. |
Extension | GA |
az iot central device compute-device-key
Gere uma chave SAS do dispositivo derivado.
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 --primary-key
Exemplos
Uso Básico
az iot central device compute-device-key --pk {primaryKey} --device-id {deviceid}
Parâmetros Exigidos
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
A chave de acesso compartilhado simétrica primária armazenada no formato base64.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central device create
Crie um dispositivo no IoT Central.
az iot central device create --app-id
--device-id
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--device-name]
[--organizations --orgs]
[--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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
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
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Nome do dispositivo legível humano. Exemplo: frigorífico.
Atribua o dispositivo às organizações especificadas. Lista separada por vírgulas de IDs da organização. Versão mínima com suporte: versão 1.1-preview.
Adicione esse sinalizador se você quiser que o IoT Central configure isso como um dispositivo simulado. --template será necessário se isso for verdadeiro.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
| Valores aceitos: | false, true |
ID do modelo central. Exemplo: dtmi:ojpkindbz:modelDefinition:iild3tm_uo.
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central device delete
Exclua um dispositivo do IoT Central.
az iot central device delete --app-id
--device-id
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--token]
Exemplos
Excluir um dispositivo
az iot central device delete --app-id {appid} --device-id {deviceid}
Parâmetros Exigidos
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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 --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Listar apenas dispositivos do IoT Edge.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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 --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--mn --module-name]
[--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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
O nome do módulo do dispositivo.
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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 --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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 --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--token]
Exemplos
Reverte o comando de failover executado anteriormente movendo o dispositivo de volta para seu Hub IoT original
az iot central device manual-failback --app-id {appid} --device-id {deviceid}
Parâmetros Exigidos
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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 minutos ttl, 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 --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--token]
[--ttl --ttl-minutes]
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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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.
Um número inteiro positivo. TTL em minutos para mover o dispositivo de volta para o hub original. Tem o valor padrão no back-end. Consulte a documentação sobre qual é o tempo padrão de back-end mais recente para o valor dinâmico visitando https://github.com/iot-for-all/iot-central-high-availability-clients#readme.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central device registration-info
Obtenha informações de registro em dispositivos do IoT Central.
Observação: esse comando pode levar um tempo significativo 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 --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot central device show
Obtenha um dispositivo do IoT Central.
az iot central device show --app-id
--device-id
[--api-version --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--token]
Exemplos
Obter um dispositivo
az iot central device show --app-id {appid} --device-id {deviceid}
Parâmetros Exigidos
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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 --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--token]
Exemplos
Obter credenciais de dispositivo para um dispositivo
az iot central device show-credentials --app-id {appid} --device-id {deviceid}
Parâmetros Exigidos
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
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 --av {2022-06-30-preview, 2022-07-31}]
[--central-api-uri --central-dns-suffix]
[--device-name]
[--enable {false, true}]
[--organizations --orgs]
[--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}
Transformar 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
A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.
A ID do dispositivo de destino. Você pode encontrar a ID do dispositivo clicando no botão Conectar na página Detalhes do Dispositivo.
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.
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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 2022-07-31 |
| Valores aceitos: | 2022-06-30-preview, 2022-07-31 |
O sufixo DNS do IoT Central associado ao seu aplicativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | azureiotcentral.com |
Nome do dispositivo legível humano. Exemplo: frigorífico.
Adicione esse sinalizador se você quiser que o IoT Central habilite ou desabilite o dispositivo.
| Propriedade | Valor |
|---|---|
| Valores aceitos: | false, true |
Atribua o dispositivo às organizações especificadas. Lista separada por vírgulas de IDs da organização. Versão mínima com suporte: versão 1.1-preview.
Adicione esse sinalizador se você quiser que o IoT Central configure isso como um dispositivo simulado. --template será necessário se isso for verdadeiro.
| Propriedade | Valor |
|---|---|
| Valores aceitos: | false, true |
ID do modelo central. Exemplo: dtmi:ojpkindbz:modelDefinition:iild3tm_uo.
Se preferir enviar sua solicitação sem se 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
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |