az iot central device twin

Observação

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

Gerencie gêmeos de dispositivos do IoT Central.

Comandos

Nome Description Tipo Status
az iot central device twin replace

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

Extensão GA
az iot central device twin show

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

Extensão GA
az iot central device twin update

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

Extensão GA

az iot central device twin replace

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

Fornecendo --component-name, --module-name ou ambos para substituir as propriedades do componente do dispositivo, as propriedades do módulo do dispositivo ou as propriedades do componente do módulo do dispositivo.

az iot central device twin replace --app-id
                                   --content
                                   --device-id
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--co]
                                   [--mn]
                                   [--token]

Exemplos

Substituir propriedades do dispositivo

az iot central device twin replace --app-id {appid} --device-id {deviceid} -k {content}

Substituir propriedades do componente do dispositivo

az iot central device twin replace --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

Substituir propriedades do componente do módulo do dispositivo

az iot central device twin replace --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

Parâmetros Exigidos

--app-id -n

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

--content -k

Configuração para solicitação. Forneça caminho para o arquivo JSON ou JSON stringificado bruto. [Exemplo de caminho do arquivo: ./path/to/file.json] [Exemplo JSON stringificado: {'a': 'b'}].

--device-id -d

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

Parâmetros Opcionais

--api-version --av
Preterido

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

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

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--co --component-name

O nome do componente do dispositivo.

--mn --module-name

O nome do módulo do dispositivo.

--token

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

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central device 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.

Fornecendo --component-name, --module-name ou ambos para obter propriedades de componente de dispositivo, propriedades de módulo de dispositivo ou propriedades de componente de módulo de dispositivo.

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

Exemplos

Obter propriedades do dispositivo

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

Obter propriedades do componente do dispositivo

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

Obter propriedades do componente do módulo do dispositivo

az iot central device twin show --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname}

Parâmetros Exigidos

--app-id -n

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

--device-id -d

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

Parâmetros Opcionais

--api-version --av
Preterido

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

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

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--co --component-name

O nome do componente do dispositivo.

--mn --module-name

O nome do módulo do dispositivo.

--token

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

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central device 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.

Fornecendo --component-name, --module-name ou ambos para atualizar as propriedades do componente do dispositivo, as propriedades do módulo do dispositivo ou as propriedades do componente do módulo do dispositivo.

az iot central device twin update --app-id
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--mn]
                                  [--token]

Exemplos

Atualizar propriedades do dispositivo

az iot central device twin update --app-id {appid} --device-id {deviceid} -k {content}

Atualizar propriedades do componente do dispositivo

az iot central device twin update --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

Atualizar propriedades do componente do módulo do dispositivo

az iot central device twin update --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

Parâmetros Exigidos

--app-id -n

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

--content -k

Configuração para solicitação. Forneça caminho para o arquivo JSON ou JSON stringificado bruto. [Exemplo de caminho do arquivo: ./path/to/file.json] [Exemplo JSON stringificado: {'a': 'b'}].

--device-id -d

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

Parâmetros Opcionais

--api-version --av
Preterido

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

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

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

valor padrão: azureiotcentral.com
--co --component-name

O nome do componente do dispositivo.

--mn --module-name

O nome do módulo do dispositivo.

--token

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

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.