az iot hub device-twin

Nota

Esta referência faz parte da extensão azure-iot da CLI do Azure (versão 2.37.0 ou superior). A extensão irá instalar automaticamente a primeira vez que executar um comando az iot hub device-twin . Saiba mais sobre as extensões.

Gerir a configuração de dispositivo duplo IoT.

Comandos

az iot hub device-twin list	Listar dispositivos duplos numa Hub IoT.
az iot hub device-twin replace	Substitua a definição do dispositivo duplo pelo json de destino.
az iot hub device-twin show	Obter uma definição de dispositivo duplo.
az iot hub device-twin update	Atualize as propriedades e etiquetas pretendidas do dispositivo duplo.

az iot hub device-twin list

Listar dispositivos duplos numa Hub IoT.

Este comando é o mesmo que a consulta do hub iot com a consulta "select * from devices" para todos os dispositivos e "select * from devices where capabilities.iotEdge = true" para dispositivos edge.

az iot hub device-twin list [--auth-type {key, login}]
                            [--edge-enabled {false, true}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

Parâmetros Opcionais

--auth-type

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

valores aceites: key, login

valor predefinido: key

--edge-enabled --ee

Sinalizador que indica a ativação do limite.

valores aceites: false, true

valor predefinido: False

--hub-name -n

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--resource-group -g

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

--top

Número máximo de elementos a devolver. Utilize -1 para ilimitado.

valor predefinido: 1000

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-twin replace

Substitua a definição do dispositivo duplo pelo json de destino.

Introduza 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 duplo pelo conteúdo do ficheiro.

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

Parâmetros Obrigatórios

--device-id -d

ID do Dispositivo de Destino.

--json -j

Json para substituir duplo existente por. Indique o caminho do ficheiro ou json não processado.

Parâmetros Opcionais

--auth-type

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

valores aceites: key, login

valor predefinido: key

--etag -e

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

--hub-name -n

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--resource-group -g

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

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-twin show

Obter uma definição de dispositivo duplo.

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

Parâmetros Obrigatórios

--device-id -d

ID do Dispositivo de Destino.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão de Azure AD atual. Pode configurar a predefinição com 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 --login não for fornecido.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--resource-group -g

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

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-twin update

Atualize as propriedades e etiquetas pretendidas do dispositivo duplo.

Forneça argumentos --desired ou --tags para o comportamento patch. Ambos os parâmetros suportam json inline ou um caminho de ficheiro para conteúdo json. A utilização de args de atualização genéricas (ou seja, --set) refletirá o comportamento put e será preterido.

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

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

Afixar etiquetas de dispositivo duplo.

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

Afixe etiquetas de dispositivo duplo 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 patch da propriedade pretendida "crítica" da "temperatura" principal

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

Parâmetros Obrigatórios

--device-id -d

ID do Dispositivo de Destino.

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos ao especificar um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string ou cadeia JSON>.

valor predefinido: []

--auth-type

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

valores aceites: key, login

valor predefinido: key

--desired

Propriedades pretendidas do duplo.

--etag -e

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

--force-string

Ao utilizar "set" ou "add", preserve os literais de cadeia em vez de tentar converter em JSON.

valor predefinido: False

--hub-name -n

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OR --remove propertyToRemove.

valor predefinido: []

--resource-group -g

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

--set

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

valor predefinido: []

--tags

Etiquetas de duplos.

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.