az iot edge deployment

  • Referência

Nota

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 az iot edge deployment . Saiba mais sobre extensões.

Gerencie implantações do IoT Edge em escala.

Comandos

Name Description Tipo Status
az iot edge deployment create

Crie uma implantação do IoT Edge em um Hub IoT de destino.

 Extensão GA
az iot edge deployment delete

Exclua uma implantação do IoT Edge.

 Extensão GA
az iot edge deployment list

Liste implantações do IoT Edge em um Hub IoT.

 Extensão GA
az iot edge deployment show

Obtenha os detalhes de uma implantação do IoT Edge.

 Extensão GA
az iot edge deployment show-metric

Avalie uma métrica do sistema de destino definida em uma implantação do IoT Edge.

 Extensão GA
az iot edge deployment update

Atualize as propriedades especificadas de uma implantação do IoT Edge.

 Extensão GA

az iot edge deployment create

Crie uma implantação do IoT Edge em um Hub IoT de destino.

O conteúdo de implantação é json e na forma de {"modulesContent":{...}} ou {"content":{"modulesContent":{...}}}.

Por padrão, as propriedades dos módulos do sistema $edgeAgent e $edgeHub são validadas em relação aos esquemas instalados com a extensão IoT. Essa validação destina-se a implantações de base. Se o esquema correspondente não estiver disponível ou o formato de implantação base não for detetado, esta etapa será ignorada. A validação de esquema pode ser desabilitada usando a opção --no-validation.

Uma implantação de borda é classificada como em camadas se um módulo tiver properties.desired.* definido. Qualquer dispositivo de borda direcionado por uma implantação em camadas, primeiro precisa de uma implantação base aplicada a ele.

Todas as implantações em camadas direcionadas a um dispositivo devem ter uma prioridade maior do que a implantação base desse dispositivo.

Nota: Se o campo properties.desired de um módulo gêmeo estiver definido em uma implantação em camadas, properties.desired substituirá as propriedades desejadas para esse módulo em quaisquer implantações de prioridade mais baixa.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl]
                              [--cmq]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

Exemplos

Crie uma implantação com rótulos (exemplo de sintaxe bash) que se aplique a dispositivos no 'edifício 9' e o ambiente seja 'teste'.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Crie uma implantação com rótulos (exemplo de sintaxe do powershell) que se aplique a dispositivos marcados com o ambiente 'dev'.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

Crie uma implantação em camadas que se aplique a dispositivos marcados com o ambiente 'dev'. Métricas de usuário e conteúdo de módulos definidos em linha (exemplo de sintaxe powershell). Observe que isso está no formato de implantação em camadas, pois properties.desired.* foi definido.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
  'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"

Crie uma implantação em camadas que se aplique a dispositivos no 'edifício 9' e no ambiente 'teste'. Tanto as métricas do usuário quanto o conteúdo dos módulos definidos em linha (exemplo de sintaxe bash). Observe que isso está no formato de implantação em camadas, pois properties.desired.* foi definido.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'

Crie uma implantação que se aplique a dispositivos no 'edifício 9' e no ambiente 'teste'. As métricas do usuário e o conteúdo dos módulos definidos a partir do arquivo.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json

Crie uma implantação cuja definição seja de arquivo com entrada independente de shell de rótulos e métricas.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Parâmetros Obrigatórios

--content -k

Conteúdo de implantação do IoT Edge. Forneça o caminho do arquivo ou json bruto.

--deployment-id -d

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

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

Valores aceites: key, login
Default value: 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 chave=valor 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 ou nome do host do Hub IoT. Obrigatório se --login não for fornecido.

--lab --labels

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

--layered

As implantações em camadas permitem definir as propriedades desejadas em módulos $edgeAgent, $edgeHub e usuário que serão colocados em camadas sobre uma implantação base. As propriedades especificadas em uma implantação em camadas serão mescladas com as propriedades da implantação base. As propriedades com o mesmo caminho serão substituídas com base na prioridade de implantação. Esta opção é um alias para --no-validation.

Valores aceites: false, true
Default value: False
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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 de métricas de usuário de implantação do IoT Edge. Forneça o caminho do arquivo ou json bruto. As métricas do usuário estão na forma de {"consultas":{...}} ou {"métricas":{"consultas":{...}}}. Recomenda-se o uso de --custom-metric-queries em vez de --metrics.

--no-validation

Desabilita a validação de esquema do lado do cliente para a criação de implantação de borda.

Valores aceites: false, true
Default value: False
--pri --priority

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

Default value: 0
--resource-group -g

o 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 à qual uma implantação de borda se aplica. Implantações sem condição de destino não terão como alvo nenhum dispositivo. Use o seguinte formato: "tags.environment='test'".

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az iot edge deployment delete

Exclua uma implantação do IoT Edge.

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

Parâmetros Obrigatórios

--deployment-id -d

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

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

Valores aceites: key, login
Default value: key
--etag -e

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

--hub-name -n

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

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az iot edge deployment list

Liste implantações do IoT Edge em um Hub IoT.

az iot edge deployment 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 de 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>.

Valores aceites: key, login
Default value: key
--hub-name -n

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

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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

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

--top

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az iot edge deployment show

Obtenha os detalhes de uma implantação do IoT Edge.

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

Parâmetros Obrigatórios

--deployment-id -d

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

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

Valores aceites: key, login
Default value: key
--hub-name -n

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

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az iot edge deployment show-metric

Avalie uma métrica do sistema de destino definida em uma implantação do IoT Edge.

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

Exemplos

Avaliar a métrica do sistema 'appliedCount'

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

Avaliar a métrica de usuário 'myCustomMetric'

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

Parâmetros Obrigatórios

--deployment-id -d

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

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

Valores aceites: key, login
Default value: key
--hub-name -n

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

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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 aceites: system, user
Default value: user
--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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

az iot edge deployment update

Atualize as propriedades especificadas de uma implantação do IoT Edge.

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

Observação: o conteúdo da implantação do IoT Edge é imutável. As propriedades de implantação que podem ser atualizadas são 'labels', 'metrics', 'priority' e 'targetCondition'.

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

Exemplos

Alterar os rótulos e a condição de destino de uma implantação de borda existente

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

Parâmetros Obrigatórios

--deployment-id -d

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

Parâmetros Opcionais

--add

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

Default value: []
--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 de 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>.

Valores aceites: key, login
Default value: key
--etag -e

Etag ou entity tag 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 string em vez de tentar converter para JSON.

Default value: False
--hub-name -n

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

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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> OR --remove propertyToRemove.

Default value: []
--resource-group -g

o 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 ser definido. Exemplo: --set property1.property2=<value>.

Default value: []
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

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

--verbose

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