Partilhar via


az iot central device

Note

Esta referência faz parte da extensão azure-iot para o CLI do Azure (versão 2.70.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando dispositivo central az iot. 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.

Extension disponibilidade geral
az iot central device attestation create

Crie um atestado de dispositivo individual.

Extension disponibilidade geral
az iot central device attestation delete

Remova um atestado de dispositivo individual.

Extension disponibilidade geral
az iot central device attestation show

Obtenha o atestado do dispositivo.

Extension disponibilidade geral
az iot central device attestation update

Atualize um atestado de dispositivo individual via patch.

Extension disponibilidade geral
az iot central device c2d-message

Execute comandos de mensagens da nuvem para o dispositivo do dispositivo.

Extension disponibilidade geral
az iot central device c2d-message purge

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

Extension disponibilidade geral
az iot central device command

Execute comandos de dispositivo.

Extension disponibilidade geral
az iot central device command history

Obtenha os detalhes da última solicitação de comando e resposta enviada ao dispositivo.

Extension disponibilidade geral
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.

Extension disponibilidade geral
az iot central device compute-device-key

Gere uma chave SAS de dispositivo derivada.

Extension disponibilidade geral
az iot central device create

Crie um dispositivo no IoT Central.

Extension disponibilidade geral
az iot central device delete

Exclua um dispositivo do IoT Central.

Extension disponibilidade geral
az iot central device edge

Gerencie e configure dispositivos de borda do IoT Central.

Extension disponibilidade geral
az iot central device edge children

Gerir dispositivos infantis IoT Edge.

Extension disponibilidade geral
az iot central device edge children add

Adicione dispositivos como crianças 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 disponibilidade geral
az iot central device edge children remove

Remova dispositivos filho de um dispositivo de borda de destino.

Extension Preview
az iot central device edge manifest

Gerir manifestos de dispositivos IoT Edge.

Extension Preview
az iot central device edge manifest show

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

Extension Preview
az iot central device edge module

Gerir módulos de dispositivos IoT Edge.

Extension Preview
az iot central device edge module list

Obtenha a lista de módulos num dispositivo IoT Edge.

Extension Preview
az iot central device edge module restart

Reiniciar um módulo num dispositivo IoT Edge.

Extension Preview
az iot central device edge module show

Arranja um módulo num dispositivo IoT Edge.

Extension Preview
az iot central device list

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

Extension disponibilidade geral
az iot central device list-components

Liste os componentes presentes em um dispositivo.

Extension disponibilidade geral
az iot central device list-modules

Liste os módulos presentes em um dispositivo.

Extension disponibilidade geral
az iot central device manual-failback

Reverte o comando de failover executado anteriormente ao mover o dispositivo de volta para o seu Hub IoT original.

Extension disponibilidade geral
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 DPS a um Hub IoT diferente.

Extension disponibilidade geral
az iot central device registration-info

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

Extension disponibilidade geral
az iot central device show

Obtenha um dispositivo do IoT Central.

Extension disponibilidade geral
az iot central device show-credentials

Obtenha credenciais de dispositivo do IoT Central.

Extension disponibilidade geral
az iot central device telemetry

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

Extension disponibilidade geral
az iot central device telemetry show

Obtenha o último valor de telemetria de um dispositivo.

Extension disponibilidade geral
az iot central device twin

Gerencie gêmeos de dispositivos do IoT Central.

Extension disponibilidade geral
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 disponibilidade geral
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 disponibilidade geral
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.

Extension disponibilidade geral
az iot central device update

Atualize um dispositivo no IoT Central.

Extension disponibilidade geral

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 --primary-key
                                         [--acquire-policy-token]
                                         [--change-reference]

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 Opcionais

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot central device create

Crie um dispositivo no IoT Central.

az iot central device create --app-id
                             --device-id
                             [--acquire-policy-token]
                             [--api-version --av {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri --central-dns-suffix]
                             [--change-reference]
                             [--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 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

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--change-reference

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

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

Exemplo: dtmi:ojpkindbz:modelDefinition:iild3tm_uo.

--token

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot central device delete

Exclua um dispositivo do IoT Central.

az iot central device delete --app-id
                             --device-id
                             [--acquire-policy-token]
                             [--api-version --av {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri --central-dns-suffix]
                             [--change-reference]
                             [--token]

Exemplos

Excluir 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

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--change-reference

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

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

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: 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 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

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

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

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

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

Lista apenas dispositivos IoT Edge.

Propriedade Valor
Default value: False
--token

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot central device list-components

Liste os componentes presentes em um dispositivo.

az iot central device list-components --app-id
                                      --device-id
                                      [--acquire-policy-token]
                                      [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri --central-dns-suffix]
                                      [--change-reference]
                                      [--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 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

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--change-reference

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--mn --module-name

O nome do módulo do dispositivo.

--token

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: 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
                                   [--acquire-policy-token]
                                   [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri --central-dns-suffix]
                                   [--change-reference]
                                   [--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

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--change-reference

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

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

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot central device manual-failback

Reverte o comando de failover executado anteriormente ao mover o dispositivo de volta para o seu 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
                                      [--acquire-policy-token]
                                      [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri --central-dns-suffix]
                                      [--change-reference]
                                      [--token]

Exemplos

Reverte o comando de failover executado anteriormente ao mover o dispositivo de volta para o seu 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

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--change-reference

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

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

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: 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 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
                                      [--acquire-policy-token]
                                      [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri --central-dns-suffix]
                                      [--change-reference]
                                      [--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 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

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--change-reference

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

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

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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 padrão do back-end mais recente, visitando 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

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
                                        [--acquire-policy-token]
                                        [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                        [--central-api-uri --central-dns-suffix]
                                        [--change-reference]
                                        [--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

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--change-reference

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

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

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: 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 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

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

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

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--token

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot central device show-credentials

Obtenha credenciais de dispositivo do IoT Central.

az iot central device show-credentials --app-id
                                       --device-id
                                       [--acquire-policy-token]
                                       [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri --central-dns-suffix]
                                       [--change-reference]
                                       [--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

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--change-reference

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

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

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: 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
                             [--acquire-policy-token]
                             [--api-version --av {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri --central-dns-suffix]
                             [--change-reference]
                             [--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}

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

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

--acquire-policy-token

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
Default value: 2022-07-31
Valores aceites: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade Valor
Default value: azureiotcentral.com
--change-reference

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

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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.

Propriedade Valor
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.

Propriedade Valor
Valores aceites: false, true
--template

Exemplo: dtmi:ojpkindbz:modelDefinition:iild3tm_uo.

--token

Se preferir submeter o seu pedido sem autenticar contra a CLI do Azure, pode especificar um token de utilizador válido para autenticar o seu pedido. 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False