az iot hub configuration

  • Referência

Observação

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

Gerenciar a configuração automática de gerenciamento de dispositivos da IoT em escala.

Comandos

Nome Description Tipo Status
az iot hub configuration create

Crie uma configuração de gerenciamento automático de dispositivos IoT em um Hub IoT de destino.

 Extensão GA
az iot hub configuration delete

Exclua uma configuração de dispositivo IoT.

 Extensão GA
az iot hub configuration list

Listar configurações de gerenciamento automático de dispositivos IoT em um Hub IoT.

 Extensão GA
az iot hub configuration show

Obtenha os detalhes de uma configuração de gerenciamento automático de dispositivos IoT.

 Extensão GA
az iot hub configuration show-metric

Avalie uma métrica de usuário ou sistema de destino definida em uma configuração de dispositivo IoT.

 Extensão GA
az iot hub configuration update

Atualize as propriedades especificadas de uma configuração de gerenciamento automático de dispositivos IoT.

 Extensão GA

az iot hub configuration create

Crie uma configuração de gerenciamento automático de dispositivos IoT em um Hub IoT de destino.

O conteúdo de configuração é json e varia ligeiramente com base na intenção do dispositivo ou módulo.

As configurações do dispositivo estão na forma de {"deviceContent":{...}} ou {"content":{"deviceContent":{...}}}

As configurações do módulo estão na forma de {"moduleContent":{...}} ou {"content":{"moduleContent":{...}}}

As configurações podem ser definidas com métricas fornecidas pelo usuário para avaliação sob demanda. As métricas do usuário são json e na forma de {"consultas":{...}} ou {"metrics":{"queries":{...}}}.

Nota: A condição de destino para módulos deve começar com "from devices.modules where".

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl]
                                [--cmq]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

Exemplos

Crie uma configuração de dispositivo com uma prioridade de 3 que se aplique na condição quando um dispositivo é marcado no edifício 9 e o ambiente é 'teste'.

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Crie uma configuração de dispositivo com rótulos e forneça métricas de usuário embutidas (exemplo de sintaxe bash).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Criar uma configuração de módulo com rótulos e fornecer métricas de usuário embutidas (exemplo de sintaxe cmd)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

Crie uma configuração de módulo com conteúdo e métricas de usuário embutidas (exemplo de sintaxe do powershell).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Crie uma configuração de dispositivo com um estilo de entrada alternativo de rótulos e métricas (agnóstico de shell).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Parâmetros Exigidos

--config-id -c

Nome da configuração do dispositivo de destino. São permitidos caracteres especiais minúsculos e os seguintes: [-+%_*!'].

--content -k

Conteúdo de configuração do dispositivo. Forneça o caminho do arquivo ou o JSON bruto.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--cl --custom-labels

Um estilo de entrada alternativo (pares chave=valor separados por espaço) para --labels e destinado a substituí-lo no futuro. Exemplo de formato: key1=value1 key2="this is my value".

--cmq --custom-metric-queries

Um estilo de entrada alternativo (pares key=value separados por espaço) para --metrics e destinado a substituí-lo no futuro. Exemplo de formato: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--lab --labels

Mapa de rótulos a serem aplicados à configuração de destino. Recomenda-se o uso de --custom-labels em vez de --labels. Exemplo de formato: {"key0":"value0", "key1":"value1"}.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--metrics -m

Definições métricas de configuração de dispositivos. Forneça o caminho do arquivo ou o JSON bruto. Recomenda-se o uso de --custom-metric-queries em vez de --metrics.

--pri --priority

Peso da configuração do dispositivo em caso de regras concorrentes (maiores vitórias).

Valor padrão: 0
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--target-condition --tc -t

Condição de destino na qual uma configuração de dispositivo ou módulo se aplica. Configurações sem condição de destino não terão como alvo nenhum dispositivo ou módulo. Use o seguinte formato: "tags.environment='test'".

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 hub configuration delete

Exclua uma configuração de dispositivo IoT.

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parâmetros Exigidos

--config-id -c

Nome da configuração do dispositivo de destino. São permitidos caracteres especiais minúsculos e os seguintes: [-+%_*!'].

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--etag -e

Etag ou tag de entidade correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

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 hub configuration list

Listar configurações de gerenciamento automático de dispositivos IoT em um Hub IoT.

az iot hub configuration list [--auth-type {key, login}]
                              [--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 usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--top

Número máximo de configurações a serem retornadas. Por padrão, todas as configurações são retornadas.

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 hub configuration show

Obtenha os detalhes de uma configuração de gerenciamento automático de dispositivos IoT.

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

Parâmetros Exigidos

--config-id -c

Nome da configuração do dispositivo de destino. São permitidos caracteres especiais minúsculos e os seguintes: [-+%_*!'].

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

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 hub configuration show-metric

Avalie uma métrica de usuário ou sistema de destino definida em uma configuração de dispositivo IoT.

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type {system, user}]
                                     [--resource-group]

Exemplos

Avaliar a métrica 'warningLimit' definida pelo usuário

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

Avaliar a métrica 'appliedCount' do sistema

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

Parâmetros Exigidos

--config-id -c

Nome da configuração do dispositivo de destino. São permitidos caracteres especiais minúsculos e os seguintes: [-+%_*!'].

--metric-id -m

Métrica alvo para avaliação.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--metric-type --mt

Indica qual coleção de métricas deve ser usada para pesquisar uma métrica.

Valores aceitos: system, user
Valor padrão: user
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

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 hub configuration update

Atualize as propriedades especificadas de uma configuração de gerenciamento automático de dispositivos IoT.

Use --set seguido de atribuições de propriedade para atualizar uma configuração.

Nota: O conteúdo de configuração é imutável. As propriedades de configuração que podem ser atualizadas são 'labels', 'metrics', 'priority' e 'targetCondition'.

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

Exemplos

Alterar a prioridade de uma configuração de dispositivo e atualizar sua condição de destino

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

Parâmetros Exigidos

--config-id -c

Nome da configuração do dispositivo de destino. São permitidos caracteres especiais minúsculos e os seguintes: [-+%_*!'].

Parâmetros Opcionais

--add

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

Valor padrão: []
--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--etag -e

Etag ou tag de entidade correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

Valor padrão: False
--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

Valor padrão: []
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>.

Valor padrão: []
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.