Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Aplica-se a:
IoT Edge 1.5
Importante
O IoT Edge 1.5 LTS é a versão com suporte. O IoT Edge 1.4 LTS chegou ao fim de sua vida útil em 12 de novembro de 2024. Se você estiver em uma versão anterior, confira Atualizar o IoT Edge.
O agente do IoT Edge e hub do IoT Edge são dois módulos que compõem o runtime do IoT Edge. Para obter mais informações sobre as responsabilidades de cada módulo de runtime, confira entender o runtime do Azure IoT Edge e sua arquitetura.
Este artigo fornece as propriedades desejadas e as propriedades relatadas dos módulos gêmeos de runtime. Para obter mais informações sobre como implantar módulos em dispositivos do IoT Edge, confira como implantar módulos e estabelecer rotas no IoT Edge.
Um módulo gêmeo inclui:
Propriedades desejadas. O back-end da solução define as propriedades desejadas e o módulo as lê. O módulo também recebe notificações de alterações nas propriedades desejadas. As propriedades desejadas são usadas junto com as propriedades relatadas para sincronizar a configuração ou as condições do módulo.
Propriedades relatadas. O módulo define as propriedades relatadas e o back-end da solução as lê e consulta. As propriedades relatadas são usadas junto com as propriedades desejadas para sincronizar a configuração ou as condições do módulo.
Propriedades desejadas do EdgeAgent
O módulo gêmeo do agente do IoT Edge é chamado $edgeAgent. Ele coordena as comunicações entre o agente do IoT Edge em execução em um dispositivo e o Hub IoT. As propriedades desejadas são definidas durante a aplicação de um manifesto de implantação em um dispositivo específico como parte de uma implantação de dispositivo único ou em escala.
| Propriedade | Descrição | Obrigatório |
|---|---|---|
| imagePullPolicy | Especifica quando efetuar o pull da imagem: OnCreate ou Never. Use Nunca se a imagem já estiver no dispositivo. | Sim |
| restartPolicy | Quando o módulo deve ser reiniciado. Os valores possíveis são: Nunca: não reinicie o módulo se não estiver em execução, Sempre: sempre reinicie o módulo se não estiver em execução, Não íntegro: reinicie o módulo se não estiver íntegro. Não íntegro é o que o Docker relata com base em uma verificação de integridade, por exemplo “Não íntegro – o contêiner não está funcionando corretamente”, Com Falha: reiniciar em caso de falha. | Sim |
| runtime.type | Deve ser docker. | Sim |
| runtime.settings.minDockerVersion | Especifica a versão mínima do Docker exigida por este manifesto de implantação. | Sim |
| runtime.settings.loggingOptions | Especifica um JSON em cadeias de caracteres com as opções de registro para o contêiner do agente do IoT Edge. Saiba mais sobre as opções de log do Docker. | Não |
| runtime.settings.registryCredentials.{registryId}.username | Especifica o nome de usuário do registro de contêiner. Para Registro de Contêiner do Azure, o nome de usuário geralmente é o nome do registro. As credenciais do Registro são necessárias para imagens de módulo privadas. | Não |
| runtime.settings.registryCredentials.{registryId}.password | A senha para o registro de contêiner. | Não |
| runtime.settings.registryCredentials.{registryId}.address | O endereço do registro de contêineres. Para Registro de Contêiner do Azure, o endereço é geralmente {nome do registro}.azurecr.io. | Não |
| schemaVersion | Especifica 1.0 ou 1.1. A versão 1.1, introduzida com o IoT Edge versão 1.0.10, é recomendada. | Sim |
| status | Status desejado do módulo: Em execução ou Parado. | Obrigatório |
| systemModules.edgeAgent.type | Tem que ser docker. | Sim |
| systemModules.edgeAgent.startupOrder | Especifica um inteiro para a posição do módulo na ordem de inicialização. 0 é o primeiro e o inteiro máximo (4294967295) é o último. Se nenhum valor for fornecido, o padrão será o inteiro máximo. | Não |
| systemModules.edgeAgent.settings.image | Especifica o URI da imagem do agente do IoT Edge. O agente do IoT Edge não pode se atualizar sozinho. | Sim |
| systemModules.edgeAgent.settings.createOptions | Especifica um JSON em formato de string com opções para criar o contêiner do agente do IoT Edge. Saiba mais sobre as opções de criação do Docker. | Não |
| systemModules.edgeAgent.configuration.id | A ID da implantação que implantou este módulo. | O Hub IoT define essa propriedade quando o manifesto é aplicado usando uma implantação. Não faz parte de um manifesto de implantação. |
| systemModules.edgeHub.type | Tem que ser docker. | Sim |
| systemModules.edgeHub.status | Deve estar em execução. | Sim |
| systemModules.edgeHub.restartPolicy | Deve estar sempre. | Sim |
| systemModules.edgeHub.startupOrder | Um valor inteiro para o local que um módulo ocupa na ordem de inicialização. 0 é o primeiro e o valor inteiro máximo (4294967295) é o último. Se um valor não for fornecido, o padrão será o valor inteiro máximo. | Não |
| systemModules.edgeHub.settings.image | O URI da imagem do hub do IoT Edge. | Sim |
| systemModules.edgeHub.settings.createOptions | Um JSON em cadeias de caracteres que contém as opções para a criação do contêiner do hub do IoT Edge. Opções de criação de docker | Não |
| systemModules.edgeHub.configuration.id | A ID da implantação que implantou este módulo. | O Hub IoT define essa propriedade quando o manifesto é aplicado usando uma implantação. Não faz parte de um manifesto de implantação. |
| modules.{moduleId}.version | Uma cadeia definida pelo usuário que representa a versão desse módulo. | Sim |
| modules.{moduleId}.type | Tem que ser docker. | Sim |
| modules.{moduleId}.status | {running | stopped} | Sim |
| modules.{moduleId}.restartPolicy | {nunca | always} | Sim |
| modules.{moduleId}.startupOrder | Um valor inteiro para o localização em que um módulo ocupa na ordem de inicialização. 0 é o primeiro e o valor inteiro máximo (4294967295) é o último. Se um valor não for fornecido, o padrão será o valor inteiro máximo. | Não |
| modules.{moduleId}.imagePullPolicy | {on-create | nunca} | Não |
| modules.{moduleId}.env | Uma lista de variáveis de ambiente que devem ser passadas para o módulo. Aceita o formato "<name>": {"value": "<value>"}. |
Não |
| modules.{moduleId}.settings.image | O URI para a imagem do módulo. | Sim |
| modules.{moduleId}.settings.createOptions | Um JSON em cadeias de caracteres que contém as opções para a criação do contêiner do módulo. Opções de criação de docker | Não |
| modules.{moduleId}.configuration.id | A ID da implantação que implantou este módulo. | O Hub IoT define essa propriedade quando o manifesto é aplicado usando uma implantação. Não faz parte de um manifesto de implantação. |
| versão | A iteração atual que tem versão, confirmação e build. | Não |
Propriedades relatadas do EdgeAgent
As propriedades relatadas pelo agente do IoT Edge incluem três informações principais:
- O status do aplicativo das propriedades desejadas vistas pela última vez,
- Status dos módulos atualmente em execução no dispositivo, conforme relatado pelo agente do IoT Edge e
- Cópia das propriedades desejadas atualmente em execução no dispositivo.
A cópia das propriedades desejadas atuais ajuda a determinar se o dispositivo aplicou a implantação mais recente ou se ainda está executando um manifesto de implantação anterior.
Observação
Você pode consultar as propriedades relatadas do agente do IoT Edge com a linguagem de consulta do Hub IoT para investigar o status da implantação em escala. Saiba como usar as propriedades do agente do IoT Edge para o status em Noções básicas sobre implantações do IoT Edge para dispositivos únicos ou em escala.
A tabela a seguir não inclui as informações copiadas das propriedades desejadas.
| Propriedade | Descrição |
|---|---|
| lastDesiredStatus.code | Código de status para as últimas propriedades desejadas vistas pelo agente do IoT Edge. Valores permitidos: 200 Êxito, 400 Configuração inválida, 412 Versão do esquema inválido, 417 As propriedades desejadas estão vazias, 500 Falha. |
| lastDesiredStatus.description | A descrição do status em texto. |
| lastDesiredVersion | Este inteiro refere-se à última versão das propriedades desejadas processadas pelo agente do IoT Edge. |
| runtime.platform.OS | Relata o sistema operacional em execução no dispositivo. |
| runtime.platform.architecture | Relata a arquitetura da CPU no dispositivo. |
| schemaVersion | Versão do esquema das propriedades reportadas. |
| systemModules.edgeAgent.runtimeStatus | O status relatado do agente do IoT Edge: {running | unhealthy}. |
| systemModules.edgeAgent.statusDescription | Descrição em texto do status relatado do agente do IoT Edge. |
| systemModules.edgeAgent.exitCode | O código de saída relatado pelo contêiner do agente do IoT Edge se o contêiner for encerrado. |
| systemModules.edgeAgent.lastStartTimeUtc | Hora em que o agente do IoT Edge foi iniciado pela última vez. |
| systemModules.edgeAgent.lastExitTimeUtc | Hora em que o agente do IoT Edge foi encerrado pela última vez. |
| systemModules.edgeHub.runtimeStatus | Status do hub do IoT Edge: { running | stopped | failed | backoff | unhealthy }. |
| systemModules.edgeHub.statusDescription | Descrição de texto do status do hub do IoT Edge se não estiver íntegro. |
| systemModules.edgeHub.exitCode | Código de saída relatado pelo contêiner do hub do IoT Edge se o contêiner for encerrado. |
| systemModules.edgeHub.lastStartTimeUtc | Hora em que hub do IoT Edge foi iniciado pela última vez. |
| systemModules.edgeHub.lastExitTimeUtc | Hora em que houve saída do hub do IoT Edge pela última vez. |
| systemModules.edgeHub.lastRestartTimeUtc | Hora em que hub do IoT Edge foi reiniciado pela última vez. |
| systemModules.edgeHub.restartCount | Número de vezes que este módulo foi reiniciado como parte da política de reinicialização. |
| modules.{moduleId}.runtimeStatus | Status do módulo: { running | stopped | failed | backoff | unhealthy }. |
| modules.{moduleId}.statusDescription | Texto de descrição do status do módulo se não estiver íntegro. |
| modules.{moduleId}.exitCode | O código de saída relatado pelo contêiner do módulo se o contêiner for encerrado. |
| modules.{moduleId}.lastStartTimeUtc | Hora em que o módulo foi iniciado pela última vez. |
| modules.{moduleId}.lastExitTimeUtc | Hora em que houve saída do módulo pela última vez. |
| modules.{moduleId}.lastRestartTimeUtc | Hora em que o módulo foi reiniciado pela última vez. |
| modules.{moduleId}.restartCount | Número de vezes que este módulo foi reiniciado como parte da política de reinicialização. |
| versão | Versão da imagem. Exemplo: "version": { "version": "1.2.7", "build": "50979330", "commit": "d3ec971caa0af0fc39d2c1f91aef21e95bd0c03c" }. |
Propriedades desejadas do EdgeHub
O gêmeo do módulo para o hub do IoT Edge se chama $edgeHub e coordena as comunicações entre o hub do IoT Edge em execução em um dispositivo e o Hub IoT. As propriedades desejadas são definidas durante a aplicação de um manifesto de implantação em um dispositivo específico como parte de uma implantação de dispositivo único ou em escala.
| Propriedade | Descrição | Necessárias no manifesto de implantação |
|---|---|---|
| schemaVersion | 1.0 ou 1.1. A versão 1.1 foi introduzida com o IoT Edge versão 1.0.10 e é a recomendada. | Sim |
| routes.{routeName} | Uma cadeia de caracteres que representa uma rota do hub do IoT Edge. Para saber mais, consulte Declarar rotas. | O elemento routes pode estar presente mas vazio. |
| storeAndForwardConfiguration.timeToLiveSecs | O tempo do dispositivo em segundos que o hub do IoT Edge mantém as mensagens caso se desconecte de pontos de extremidade de roteamento do Hub IoT ou de um módulo local. Este tempo persiste em qualquer desligamento ou reinicialização. Para obter mais informações, confira Funcionalidades offline. | Sim |
Propriedades relatadas do EdgeHub
| Propriedade | Descrição |
|---|---|
| lastDesiredVersion | Este inteiro refere-se à última versão das propriedades desejadas processadas pelo hub do IoT Edge. |
| lastDesiredStatus.code | É o código de status que se refere às últimas propriedades desejadas vistas pelo hub do IoT Edge. Valores permitidos: 200 Êxito, 400 Configuração inválida, 500 Falha |
| lastDesiredStatus.description | A descrição do status em texto. |
| clientes | Todos os clientes conectados ao edgeHub com o status e a hora da última conexão. Exemplo: "clients": { "device2/SimulatedTemperatureSensor": { "status": "Connected", "lastConnectedTimeUtc": "2022-11-17T21:49:16.4781564Z" } }. |
| clients.{device or moduleId}.status | O status de conectividade do dispositivo ou do módulo. Valores possíveis {connected | disconnected}. Somente as identidades de módulo podem estar em estado desconectado. Os dispositivos downstream conectados ao hub do IoT Edge aparecem somente quando conectados. |
| clients.{device or moduleId}.lastConnectTime | Última vez em que o dispositivo ou o módulo esteve conectado. |
| clients.{device or moduleId}.lastDisconnectTime | Última vez em que o dispositivo ou módulo se desconectou. |
| schemaVersion | Versão do esquema das propriedades reportadas. |
| versão | Versão da imagem. Exemplo: "version": { "version": "1.2.7", "build": "50979330", "commit": "d3ec971caa0af0fc39d2c1f91aef21e95bd0c03c" }. |
Próximas etapas
Para saber como utilizar essas propriedades para compilar manifestos de implantação, consulte Entender como os módulos do IoT Edge podem ser utilizados, configurados e reutilizados.