az iot hub device-twin

  • Referência

Nota

Esta referência faz parte da extensão azure-iot para o Azure CLI (versão 2.24.1 ou superior). A extensão instala-se automaticamente na primeira vez que executar um comando az iot hub-twin . Saiba mais sobre extensões.

Gerir a configuração dupla do dispositivo IoT.

Comandos

az iot hub device-twin replace

Substitua a definição de twin do dispositivo por json alvo.
az iot hub device-twin show

Obter uma definição de dois dispositivos.
az iot hub device-twin update

Atualizar o dispositivo twin propriedades e tags desejadas.

az iot hub device-twin replace

Substitua a definição de twin do dispositivo por json alvo.

Insira o json diretamente ou utilize um caminho de ficheiro.

az iot hub device-twin replace --device-id
                               --json
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Exemplos

Substitua o dispositivo twin por conteúdo de ficheiro.

az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

--json -j

Json para substituir o gémeo existente por. Forneça o caminho do arquivo ou json cru.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login
valor predefinido: key
--etag -e

Etiqueta Etag ou entidade correspondente ao último estado do recurso. Se não for utilizado qualquer etiqueta etag, o valor '*» é utilizado.

--hub-name -n

Hub IoT nome. Necessário se não for fornecido o login.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub device-twin show

Obter uma definição de dois dispositivos.

az iot hub device-twin show --device-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login
valor predefinido: key
--hub-name -n

Hub IoT nome. Necessário se não for fornecido o login.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

az iot hub device-twin update

Atualizar o dispositivo twin propriedades e tags desejadas.

Fornecer argumentos desejados ou --tags para o comportamento patch. Ambos os parâmetros suportam json inline ou um caminho de arquivo para o conteúdo json. O uso de args de atualização genérica (isto é, --set) refletirá o comportamento do PUT e será depreciado.

az iot hub device-twin update --device-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Exemplos

Patch device twin propriedades desejadas.

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

Etiquetas gémeas do dispositivo de remendo.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags '{"country": "USA"}'

Corrigir etiquetas gémeas do dispositivo com conteúdo de ficheiro json.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags /path/to/file

Remoção de remendos de propriedade "crítica" desejada da 'temperatura' dos pais

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"condition":{"temperature":{"critical": null}}}'

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor chave. Exemplo: --adicionar propriedade.listProperty <chave=valor, string ou> de cadeia JSON.

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login
valor predefinido: key
--desired

Propriedades duplas desejadas.

--etag -e

Etiqueta Etag ou entidade correspondente ao último estado do recurso. Se não for utilizado qualquer etiqueta etag, o valor '*» é utilizado.

--force-string

Ao utilizar 'set' ou 'add', preserve as cordas literais em vez de tentar converter-se em JSON.

--hub-name -n

Hub IoT nome. Necessário se não for fornecido o login.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remover propriedade.list OR --remover propriedadeToRemove.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--set

Atualize um objeto especificando um caminho de propriedade e valor a definir. Exemplo: --set property1.property2=.

--tags

Etiquetas gémeas.