PowerShell-skript för IoT Edge med Windows-containrar
Gäller för:
IoT Edge 1.1
Viktigt
IoT Edge 1.1 slutdatum var den 13 december 2022. I informationen om Microsoft-produktens livscykel hittar du fler uppgifter om vilken support som gäller för denna produkt, tjänst, teknik eller detta API. Mer information om hur du uppdaterar till den senaste versionen av IoT Edge finns i Uppdatera IoT Edge.
Förstå PowerShell-skript som installerar, uppdaterar eller avinstallerar IoT Edge på Windows-enheter.
Kommandona som beskrivs i den IoTEdgeSecurityDaemon.ps1 här artikeln kommer från filen som släpps med varje IoT Edge version. Den senaste versionen av skriptet är alltid tillgänglig på aka.ms/iotedge-win.
Du kan köra något av kommandona med hjälp av cmdleten Invoke-WebRequest för att komma åt den senaste skriptversionen. Ett exempel:
. {Invoke-WebRequest -useb https://aka.ms/iotedge-win} | Invoke-Expression; `
Deploy-IoTEdge
Du kan också ladda ned det här skriptet, eller en version av skriptet från en viss version, för att köra kommandona. Ett exempel:
. <path>\IoTEdgeSecurityDaemon.ps1
Deploy-IoTEdge
Det angivna skriptet signeras för att öka säkerheten. Du kan verifiera signaturen genom att ladda ned skriptet till enheten och sedan köra följande PowerShell-kommando:
Get-AuthenticodeSignature "C:\<path>\IotEdgeSecurityDaemon.ps1"
Utdatastatusen är Giltig om signaturen har verifierats.
Deploy-IoTEdge
Kommandot Deploy-IoTEdge laddar ned och distribuerar IoT Edge Security Daemon och dess beroenden. Distributionskommandot accepterar bland annat dessa vanliga parametrar. I den fullständiga listan använder du kommandot Get-Help Deploy-IoTEdge -full.
| Parameter | Godkända värden | Kommentarer |
|---|---|---|
| Containeros | Windows eller Linux | Om inget containeroperativsystem har angetts är Windows standardvärdet. För Windows-containrar använder IoT Edge Moby-containermotorn som ingår i installationen. För Linux-containrar måste du installera en containermotor innan du startar installationen. |
| Proxy | Proxy-URL | Inkludera den här parametern om enheten behöver gå via en proxyserver för att nå Internet. Mer information finns i Konfigurera en IoT Edge enhet för kommunikation via en proxyserver. |
| OfflineInstallationPath | Katalogsökväg | Om den här parametern ingår kontrollerar installationsprogrammet katalogen i listan för de IoT Edge cab- och VC Runtime MSI-filer som krävs för installationen. Alla filer som inte hittades i katalogen laddas ned. Om båda filerna finns i katalogen kan du installera IoT Edge utan internetanslutning. Du kan också använda den här parametern för att använda en viss version. |
| InvokeWebRequestParameters | Hashtable med parametrar och värden | Under installationen görs flera webbbegäranden. Använd det här fältet för att ange parametrar för dessa webbbegäranden. Den här parametern är användbar för att konfigurera autentiseringsuppgifter för proxyservrar. Mer information finns i Konfigurera en IoT Edge enhet för kommunikation via en proxyserver. |
| RestartIfNeeded | inget | Med den här flaggan kan distributionsskriptet starta om datorn utan att fråga om det behövs. |
Initialize-IoTEdge
Kommandot Initialize-IoTEdge konfigurerar IoT Edge med enhetens anslutningssträng och driftinformation. Mycket av informationen som genereras av det här kommandot lagras sedan i filen iotedge\config.yaml. Initieringskommandot accepterar bland annat dessa vanliga parametrar. I den fullständiga listan använder du kommandot Get-Help Initialize-IoTEdge -full.
| Parameter | Godkända värden | Kommentarer |
|---|---|---|
| ManualConnectionString | Ingen | Växla parameter. Standardvärde. Om ingen etableringstyp har angetts är manuell etablering med en anslutningssträng standardvärdet. Anger att du ska ange en enhetsanslutningssträng för att etablera enheten manuellt. |
| ManualX509 | Ingen | Växla parameter. Om ingen etableringstyp har angetts är manuell etablering med en anslutningssträng standardvärdet. Deklarerar att du anger ett identitetscertifikat och en privat nyckel för att etablera enheten manuellt. |
| DpsTpm | Ingen | Växla parameter. Om ingen etableringstyp har angetts är manuell etablering med en anslutningssträng standardvärdet. Deklarerar att du anger ett DPS-omfångs-ID (Device Provisioning Service) och enhetens registrerings-ID som ska etableras via DPS. |
| DpsSymmetricKey | Ingen | Växla parameter. Om ingen etableringstyp har angetts är manuell etablering med en anslutningssträng standardvärdet. Deklarerar att du anger ett DPS-omfångs-ID (Device Provisioning Service) och enhetens registrerings-ID som ska etableras via DPS, tillsammans med en symmetrisk nyckel för attestering. |
| DpsX509 | Ingen | Växla parameter. Om ingen etableringstyp har angetts är manuell etablering med en anslutningssträng standardvärdet. Deklarerar att du anger ett DPS-omfångs-ID (Device Provisioning Service) och enhetens registrerings-ID som ska etableras via DPS, tillsammans med ett X.509-identitetscertifikat och en privat nyckel för attestering. |
| DeviceConnectionString | En anslutningssträng från en IoT Edge enhet som registrerats i en IoT Hub, med enkla citattecken | Krävs för manuell etablering med en anslutningssträng. Om du inte anger någon anslutningssträng i skriptparametrarna uppmanas du att ange en. |
| IotHubHostName | Värdnamnet för den IoT-hubb som en enhet ansluter till. | Krävs för manuell etablering med X.509-certifikat. Tar formatet {hubbnamn}.azure-devices.net. |
| Deviceid | Enhets-ID:t från en registrerad enhetsidentitet i IoT Hub. | Krävs för manuell etablering med X.509-certifikat. |
| Scopeid | Ett omfångs-ID från en instans av Device Provisioning Service som är associerad med din IoT Hub. | Krävs för DPS-etablering. Om du inte anger något omfångs-ID i skriptparametrarna uppmanas du att ange ett. |
| RegistrationId | Ett registrerings-ID som genereras av enheten | Krävs för DPS-etablering om du använder TPM eller symmetrisk nyckelattestering. Valfritt om du använder X.509-certifikatattestering. |
| X509IdentityCertificate | URI-sökvägen till X.509-enhetens identitetscertifikat på enheten. | Krävs för antingen manuell etablering eller DPS-etablering om X.509-certifikatattestering används. |
| X509IdentityPrivateKey | URI-sökvägen till X.509-enhetens identitetscertifikatnyckel på enheten. | Krävs för antingen manuell etablering eller DPS-etablering om X.509-certifikatattestering används. |
| Symmetrisk nyckel | Den symmetriska nyckeln som används för att etablera IoT Edge enhetsidentitet när dps används | Krävs för DPS-etablering om du använder symmetrisk nyckelattestering. |
| Containeros | Windows eller Linux | Om inget containeroperativsystem har angetts är Windows standardvärdet. För Windows-containrar använder IoT Edge Moby-containermotorn som ingår i installationen. För Linux-containrar måste du installera en containermotor innan du startar installationen. |
| DeviceCACertificate | URI-sökvägen till X.509-enhetens CA-certifikat på enheten. | Kan också konfigureras i C:\ProgramData\iotedge\config.yaml filen . Mer information finns i Hantera certifikat på en IoT Edge enhet. |
| DeviceCAPrivateKey | URI-sökvägen till den privata nyckeln för X.509-enhets-CA:n på enheten. | Kan också konfigureras i C:\ProgramData\iotedge\config.yaml filen . Mer information finns i Hantera certifikat på en IoT Edge enhet. |
| InvokeWebRequestParameters | Hashtabell för parametrar och värden | Under installationen görs flera webbbegäranden. Använd det här fältet för att ange parametrar för dessa webbbegäranden. Den här parametern är användbar för att konfigurera autentiseringsuppgifter för proxyservrar. Mer information finns i Konfigurera en IoT Edge-enhet för kommunikation via en proxyserver. |
| AgentImage | IoT Edge agentens avbildnings-URI | Som standard använder en ny IoT Edge-installation den senaste löpande taggen för IoT Edge agent-avbildningen. Använd den här parametern för att ange en specifik tagg för avbildningsversionen eller för att ange en egen agentbild. Mer information finns i Förstå IoT Edge taggar. |
| Användarnamn | Användarnamn för containerregister | Använd bara den här parametern om du anger parametern -AgentImage till en container i ett privat register. Ange ett användarnamn med åtkomst till registret. |
| Lösenord | Säker lösenordssträng | Använd bara den här parametern om du anger parametern -AgentImage till en container i ett privat register. Ange lösenordet för att komma åt registret. |
Update-IoTEdge
| Parameter | Godkända värden | Kommentarer |
|---|---|---|
| Containeros | Windows eller Linux | Om inget containeroperativsystem anges är Windows standardvärdet. För Windows-containrar ingår en containermotor i installationen. För Linux-containrar måste du installera en containermotor innan du startar installationen. |
| Proxy | Proxy-URL | Inkludera den här parametern om enheten behöver gå via en proxyserver för att nå Internet. Mer information finns i Konfigurera en IoT Edge-enhet för kommunikation via en proxyserver. |
| InvokeWebRequestParameters | Hashtabell för parametrar och värden | Under installationen görs flera webbbegäranden. Använd det här fältet för att ange parametrar för dessa webbbegäranden. Den här parametern är användbar för att konfigurera autentiseringsuppgifter för proxyservrar. Mer information finns i Konfigurera en IoT Edge-enhet för kommunikation via en proxyserver. |
| OfflineInstallationPath | Katalogsökväg | Om den här parametern ingår kontrollerar installationsprogrammet katalogen i listan för de IoT Edge cab- och VC Runtime MSI-filer som krävs för installation. Filer som inte hittas i katalogen laddas ned. Om båda filerna finns i katalogen kan du installera IoT Edge utan internetanslutning. Du kan också använda den här parametern för att använda en viss version. |
| RestartIfNeeded | inget | Med den här flaggan kan distributionsskriptet starta om datorn utan att fråga om det behövs. |
Uninstall-IoTEdge
| Parameter | Godkända värden | Kommentarer |
|---|---|---|
| Force | inget | Den här flaggan tvingar avinstallationen om det tidigare avinstallationsförsöket misslyckades. |
| RestartIfNeeded | inget | Med den här flaggan kan avinstallationsskriptet starta om datorn utan att fråga om det behövs. |
Nästa steg
Lär dig hur du använder dessa kommandon i följande artikel: