Scripts do PowerShell para IoT Edge com contêineres do Windows
Aplica-se a: 
IoT Edge 1.1
Importante
A data de fim do suporte do IoT Edge 1.1 foi 13 de dezembro de 2022. Consulte o Ciclo de Vida de Produtos da Microsoft para obter informações sobre como é suportado este produto, serviço, tecnologia ou API. Para obter mais informações sobre como atualizar para a versão mais recente do IoT Edge, consulte Atualizar o IoT Edge.
Entenda os scripts do PowerShell que instalam, atualizam ou desinstalam o IoT Edge em dispositivos Windows.
Os comandos descritos neste artigo são do arquivo que é lançado com cada versão do IoTEdgeSecurityDaemon.ps1 IoT Edge. A versão mais recente do script está sempre disponível em aka.ms/iotedge-win.
Você pode executar qualquer um dos comandos usando o Invoke-WebRequest cmdlet para acessar a versão de script mais recente. Por exemplo:
. {Invoke-WebRequest -useb https://aka.ms/iotedge-win} | Invoke-Expression; `
Deploy-IoTEdge
Você também pode baixar esse script, ou uma versão do script de uma versão específica, para executar os comandos. Por exemplo:
. <path>\IoTEdgeSecurityDaemon.ps1
Deploy-IoTEdge
O script fornecido é assinado para aumentar a segurança. Você pode verificar a assinatura baixando o script para seu dispositivo e executando o seguinte comando do PowerShell:
Get-AuthenticodeSignature "C:\<path>\IotEdgeSecurityDaemon.ps1"
O status de saída é Válido se a assinatura for verificada.
Deploy-IoTEdge
O comando Deploy-IoTEdge baixa e implanta o IoT Edge Security Daemon e suas dependências. O comando deployment aceita esses parâmetros comuns, entre outros. Para obter a lista completa, use o comando Get-Help Deploy-IoTEdge -full.
| Parâmetro | Valores aceites | Comentários |
|---|---|---|
| Contentores | Windows ou Linux | Se nenhum sistema operacional de contêiner for especificado, o Windows será o valor padrão. Para contêineres do Windows, o IoT Edge usa o mecanismo de contêiner Moby incluído na instalação. Para contêineres Linux, você precisa instalar um mecanismo de contêiner antes de iniciar a instalação. |
| Proxy | Proxy URL | Inclua este parâmetro se o seu dispositivo precisar passar por um servidor proxy para acessar a Internet. Para obter mais informações, consulte Configurar um dispositivo IoT Edge para se comunicar por meio de um servidor proxy. |
| OfflineInstallationPath | Directory path | Se esse parâmetro estiver incluído, o instalador verificará o diretório listado para os arquivos MSI cab e VC Runtime do IoT Edge necessários para a instalação. Todos os arquivos não encontrados no diretório são baixados. Se ambos os arquivos estiverem no diretório, você poderá instalar o IoT Edge sem uma conexão com a Internet. Você também pode usar esse parâmetro para usar uma versão específica. |
| InvokeWebRequestParameters | Tabela hash de parâmetros e valores | Durante a instalação, várias solicitações da Web são feitas. Use este campo para definir parâmetros para essas solicitações da Web. Este parâmetro é útil para configurar credenciais para servidores proxy. Para obter mais informações, consulte Configurar um dispositivo IoT Edge para se comunicar por meio de um servidor proxy. |
| RestartIfNeeded | nenhum | Esse sinalizador permite que o script de implantação reinicie a máquina sem avisar, se necessário. |
Initialize-IoTEdge
O comando Initialize-IoTEdge configura o IoT Edge com a cadeia de conexão do dispositivo e os detalhes operacionais. Muitas das informações geradas por esse comando são armazenadas no arquivo iotedge\config.yaml. O comando initialization aceita esses parâmetros comuns, entre outros. Para obter a lista completa, use o comando Get-Help Initialize-IoTEdge -full.
| Parâmetro | Valores aceites | Comentários |
|---|---|---|
| ManualConnectionString | Nenhuma | Parâmetro Switch. Valor padrão. Se nenhum tipo de provisionamento for especificado, o provisionamento manual com uma cadeia de conexão será o valor padrão. Declara que você fornecerá uma cadeia de conexão de dispositivo para provisionar o dispositivo manualmente. |
| ManualX509 | Nenhuma | Parâmetro Switch. Se nenhum tipo de provisionamento for especificado, o provisionamento manual com uma cadeia de conexão será o valor padrão. Declara que você fornecerá um certificado de identidade e uma chave privada para provisionar o dispositivo manualmente. |
| DpsTpm | Nenhuma | Parâmetro Switch. Se nenhum tipo de provisionamento for especificado, o provisionamento manual com uma cadeia de conexão será o valor padrão. Declara que você fornecerá uma ID de escopo do Serviço de Provisionamento de Dispositivo (DPS) e a ID de Registro do seu dispositivo para provisionamento por meio do DPS. |
| DpsSymmetricKey | Nenhuma | Parâmetro Switch. Se nenhum tipo de provisionamento for especificado, o provisionamento manual com uma cadeia de conexão será o valor padrão. Declara que você fornecerá uma ID de escopo do Serviço de Provisionamento de Dispositivo (DPS) e a ID de Registro do seu dispositivo para provisionamento por meio do DPS, juntamente com uma chave simétrica para atestado. |
| DPSX509 | Nenhuma | Parâmetro Switch. Se nenhum tipo de provisionamento for especificado, o provisionamento manual com uma cadeia de conexão será o valor padrão. Declara que você fornecerá uma ID de escopo do Serviço de Provisionamento de Dispositivo (DPS) e a ID de Registro do seu dispositivo para provisionamento por meio do DPS, juntamente com um certificado de identidade X.509 e uma chave privada para atestado. |
| DeviceConnectionString | Uma cadeia de conexão de um dispositivo IoT Edge registrado em um Hub IoT, entre aspas simples | Necessário para provisionamento manual com uma cadeia de conexão. Se você não fornecer uma cadeia de conexão nos parâmetros de script, será solicitada uma. |
| IotHubHostName | O nome do host do hub IoT ao qual um dispositivo se conecta. | Necessário para provisionamento manual com certificados X.509. Assume o formato {hub name}.azure-devices.net. |
| DeviceId | O ID do dispositivo de uma identidade de dispositivo registrada no Hub IoT. | Necessário para provisionamento manual com certificados X.509. |
| ScopeId | Um ID de escopo de uma instância do Serviço de Provisionamento de Dispositivo associada ao seu Hub IoT. | Necessário para provisionamento de DPS. Se você não fornecer uma ID de escopo nos parâmetros de script, será solicitada uma. |
| ID de Registo | Um ID de registo gerado pelo seu dispositivo | Necessário para provisionamento de DPS se estiver usando TPM ou atestado de chave simétrica. Opcional se estiver usando o certificado X.509. |
| X509IdentityCertificate | O caminho URI para o certificado de identidade do dispositivo X.509 no dispositivo. | Necessário para provisionamento manual ou DPS se estiver usando o certificado X.509. |
| X509IdentityPrivateKey | O caminho URI para a chave de certificado de identidade do dispositivo X.509 no dispositivo. | Necessário para provisionamento manual ou DPS se estiver usando o certificado X.509. |
| Chave simétrica | A chave simétrica usada para provisionar a identidade do dispositivo IoT Edge ao usar o DPS | Necessário para provisionamento de DPS se estiver usando atestado de chave simétrica. |
| Contentores | Windows ou Linux | Se nenhum sistema operacional de contêiner for especificado, o Windows será o valor padrão. Para contêineres do Windows, o IoT Edge usa o mecanismo de contêiner Moby incluído na instalação. Para contêineres Linux, você precisa instalar um mecanismo de contêiner antes de iniciar a instalação. |
| DeviceCACertificate | O caminho de URI para o certificado de CA do dispositivo X.509 no dispositivo. | Também pode ser configurado no C:\ProgramData\iotedge\config.yaml arquivo. Para obter mais informações, consulte Gerenciar certificados em um dispositivo IoT Edge. |
| DeviceCAPrivateKey | O caminho URI para a chave privada da autoridade de certificação do dispositivo X.509 no dispositivo. | Também pode ser configurado no C:\ProgramData\iotedge\config.yaml arquivo. Para obter mais informações, consulte Gerenciar certificados em um dispositivo IoT Edge. |
| InvokeWebRequestParameters | Tabela hash de parâmetros e valores | Durante a instalação, várias solicitações da Web são feitas. Use este campo para definir parâmetros para essas solicitações da Web. Este parâmetro é útil para configurar credenciais para servidores proxy. Para obter mais informações, consulte Configurar um dispositivo IoT Edge para se comunicar por meio de um servidor proxy. |
| AgentImage | URI da imagem do agente do IoT Edge | Por padrão, uma nova instalação do IoT Edge usa a marca contínua mais recente para a imagem do agente do IoT Edge. Use esse parâmetro para definir uma tag específica para a versão da imagem ou para fornecer sua própria imagem do agente. Para obter mais informações, consulte Compreender as tags do IoT Edge. |
| Nome de utilizador | Nome de usuário do registro de contêiner | Use esse parâmetro somente se você definir o parâmetro -AgentImage como um contêiner em um registro privado. Forneça um nome de usuário com acesso ao registro. |
| Palavra-passe | Cadeia de caracteres de senha segura | Use esse parâmetro somente se você definir o parâmetro -AgentImage como um contêiner em um registro privado. Forneça a senha para acessar o registro. |
Update-IoTEdge
| Parâmetro | Valores aceites | Comentários |
|---|---|---|
| Contentores | Windows ou Linux | Se nenhum sistema operacional de contêiner for especificado, o Windows será o valor padrão. Para contêineres do Windows, um mecanismo de contêiner será incluído na instalação. Para contêineres Linux, você precisa instalar um mecanismo de contêiner antes de iniciar a instalação. |
| Proxy | Proxy URL | Inclua este parâmetro se o seu dispositivo precisar passar por um servidor proxy para acessar a Internet. Para obter mais informações, consulte Configurar um dispositivo IoT Edge para se comunicar por meio de um servidor proxy. |
| InvokeWebRequestParameters | Tabela hash de parâmetros e valores | Durante a instalação, várias solicitações da Web são feitas. Use este campo para definir parâmetros para essas solicitações da Web. Este parâmetro é útil para configurar credenciais para servidores proxy. Para obter mais informações, consulte Configurar um dispositivo IoT Edge para se comunicar por meio de um servidor proxy. |
| OfflineInstallationPath | Directory path | Se esse parâmetro estiver incluído, o instalador verificará o diretório listado para os arquivos MSI cab e VC Runtime do IoT Edge necessários para a instalação. Todos os arquivos não encontrados no diretório são baixados. Se ambos os arquivos estiverem no diretório, você poderá instalar o IoT Edge sem uma conexão com a Internet. Você também pode usar esse parâmetro para usar uma versão específica. |
| RestartIfNeeded | nenhum | Esse sinalizador permite que o script de implantação reinicie a máquina sem avisar, se necessário. |
Desinstalar-IoTEdge
| Parâmetro | Valores aceites | Comentários |
|---|---|---|
| Força | nenhum | Esse sinalizador força a desinstalação caso a tentativa anterior de desinstalação não tenha sido bem-sucedida. |
| RestartIfNeeded | nenhum | Esse sinalizador permite que o script de desinstalação reinicie a máquina sem avisar, se necessário. |
Próximos passos
Saiba como usar esses comandos no seguinte artigo: