共用方式為


適用於IoT Edge與 Windows 容器的PowerShell腳本

適用於: 是圖示 IoT Edge 1.1

重要

IoT Edge 1.1 終止支援日期為 2022 年 12 月 13 日。 如需此產品、服務、技術或 API 的支援資訊,請參閱 Microsoft 產品生命週期。 如需更新至最新版IoT Edge的詳細資訊,請參閱 更新IoT Edge

瞭解在 Windows 裝置上安裝、更新或卸載 IoT Edge 的 PowerShell 腳本。

本文所述的命令來自 IoTEdgeSecurityDaemon.ps1 隨每個 IoT Edge版本發行的檔案。 最新版本的腳本一律可在 aka.ms/iotedge-win 取得。

您可以使用 Cmdlet 執行任何命令 Invoke-WebRequest ,以存取最新的文稿版本。 例如:

. {Invoke-WebRequest -useb https://aka.ms/iotedge-win} | Invoke-Expression; `
Deploy-IoTEdge

您也可以從特定版本下載此腳本或腳本的版本,以執行命令。 例如:

. <path>\IoTEdgeSecurityDaemon.ps1
Deploy-IoTEdge

提供的腳本會簽署以增加安全性。 您可以將文稿下載到您的裝置,然後執行下列 PowerShell 命令來驗證簽章:

Get-AuthenticodeSignature "C:\<path>\IotEdgeSecurityDaemon.ps1"

如果已驗證簽章,則輸出狀態為 [有效 ]。

Deploy-IoTEdge

Deploy-IoTEdge 命令會下載並部署IoT Edge安全性精靈及其相依性。 部署命令會接受這些常見的參數等等。 如需完整清單,請使用 命令 Get-Help Deploy-IoTEdge -full

參數 接受的值 註解
ContainerOs WindowsLinux 如果未指定任何容器作業系統,Windows 就是預設值。

針對 Windows 容器,IoT Edge 會使用安裝中包含的 Moby 容器引擎。 針對 Linux 容器,您必須先安裝容器引擎,才能開始安裝。
Proxy Proxy URL 如果您的裝置需要透過 Proxy 伺服器連線到因特網,請包含此參數。 如需詳細資訊,請參閱設定 IoT Edge 裝置以透過 Proxy 伺服器進行通訊
OfflineInstallationPath 目錄路徑 如果包含此參數,安裝程式會檢查安裝所需的 IoT Edge cab 和 VC Runtime MSI 檔案列出的目錄。 下載目錄中找不到的任何檔案。 如果這兩個檔案都在目錄中,您可以安裝IoT Edge,而不需要因特網連線。 您也可以使用此參數來使用特定版本。
InvokeWebRequestParameters 參數和值的哈希表 在安裝期間,會提出數個 Web 要求。 使用此欄位來設定這些 Web 要求的參數。 此參數有助於設定 Proxy 伺服器的認證。 如需詳細資訊,請參閱設定 IoT Edge 裝置以透過 Proxy 伺服器進行通訊
RestartIfNeeded none 此旗標可讓部署腳本在必要時重新啟動機器,而不提示。

Initialize-IoTEdge

Initialize-IoTEdge 命令會使用您的裝置來設定 IoT Edge 連接字串 和操作詳細數據。 此命令所產生的大部分資訊會儲存在 iotedge\config.yaml 檔案中。 初始化命令會接受這些通用參數,以及其他參數。 如需完整清單,請使用 命令 Get-Help Initialize-IoTEdge -full

參數 接受的值 註解
ManualConnectionString Switch 參數預設值。 如果未指定任何布建類型,則使用 連接字串 手動布建是預設值。

宣告您將提供裝置 連接字串 手動布建裝置。
ManualX509 Switch 參數。 如果未指定任何布建類型,則使用 連接字串 手動布建是預設值。

宣告您將提供身分識別憑證和私鑰,以手動布建裝置。
DpsTpm Switch 參數。 如果未指定任何布建類型,則使用 連接字串 手動布建是預設值。

宣告您將提供裝置布建服務 (DPS) 範圍標識碼和裝置的註冊標識碼,以透過 DPS 進行佈建。
DpsSymmetricKey Switch 參數。 如果未指定任何布建類型,則使用 連接字串 手動布建是預設值。

宣告您將提供裝置佈建服務 (DPS) 範圍標識碼和裝置的註冊標識碼,以透過 DPS 佈建,以及用於證明的對稱密鑰。
DpsX509 Switch 參數。 如果未指定任何布建類型,則使用 連接字串 手動布建是預設值。

宣告您將提供裝置布建服務 (DPS) 範圍標識碼和裝置的註冊標識碼,以透過 DPS 布建,以及 X.509 身分識別憑證和私鑰進行證明。
DeviceConnectionString IoT 中樞 中註冊之 IoT Edge 裝置的 連接字串,單引號 使用 連接字串 進行手動布建的必要專案。 如果您沒有在文稿參數中提供 連接字串,系統會提示您輸入一個。
IotHubHostName 裝置所連線之IoT中樞的主機名。 需要 以 X.509 憑證手動布建。 採用 {hub name}.azure-devices.net 格式
DeviceId IoT 中樞 中已註冊裝置身分識別的裝置標識碼。 需要 以 X.509 憑證手動布建。
ScopeId 與 IoT 中樞 相關聯的裝置布建服務實例的範圍標識碼。 DPS 布建的必要 專案。 如果您未在文稿參數中提供範圍標識碼,系統會提示您輸入範圍標識碼。
RegistrationId 裝置所產生的註冊標識碼 如果使用 TPM 或對稱金鑰證明,則為 DPS 佈建的必要 專案。 如果使用 X.509 憑證證明,則為選擇性
X509IdentityCertificate 裝置上 X.509 裝置身分識別憑證的 URI 路徑。 如果使用 X.509 憑證證明,則需要手動或 DPS 布建。
X509IdentityPrivateKey 裝置上 X.509 裝置身分識別憑證金鑰的 URI 路徑。 如果使用 X.509 憑證證明,則需要手動或 DPS 布建。
SymmetricKey 使用 DPS 時用來佈建 IoT Edge 裝置身分識別的對稱密鑰 如果使用對稱密鑰證明,則為 DPS 佈建的必要 專案。
ContainerOs WindowsLinux 如果未指定任何容器作業系統,Windows 就是預設值。

針對 Windows 容器,IoT Edge 會使用安裝中包含的 Moby 容器引擎。 針對 Linux 容器,您必須先安裝容器引擎,才能開始安裝。
DeviceCACertificate 裝置上 X.509 裝置 CA 憑證的 URI 路徑。 也可以在檔案中 C:\ProgramData\iotedge\config.yaml 設定。 如需詳細資訊,請參閱 管理 IoT Edge 裝置上的憑證。
DeviceCAPrivateKey 裝置上 X.509 裝置 CA 私鑰的 URI 路徑。 也可以在檔案中 C:\ProgramData\iotedge\config.yaml 設定。 如需詳細資訊,請參閱 管理 IoT Edge 裝置上的憑證。
InvokeWebRequestParameters 參數和值的哈希表 在安裝期間,會提出數個 Web 要求。 使用此欄位來設定這些 Web 要求的參數。 此參數有助於設定 Proxy 伺服器的認證。 如需詳細資訊,請參閱設定 IoT Edge 裝置以透過 Proxy 伺服器進行通訊
AgentImage IoT Edge 代理程式映像 URI 根據預設,新的IoT Edge安裝會使用IoT Edge代理程式映像的最新滾動標籤。 使用此參數來設定映像版本的特定標籤,或提供您自己的代理程式映像。 如需詳細資訊,請參閱 瞭解IoT Edge標籤
使用者名稱 容器登錄用戶名稱 只有在您將 -AgentImage 參數設定為私人登錄中的容器時,才使用此參數。 提供具有登錄存取權的用戶名稱。
密碼 安全密碼字串 只有在您將 -AgentImage 參數設定為私人登錄中的容器時,才使用此參數。 提供密碼以存取登錄。

Update-IoTEdge

參數 接受的值 註解
ContainerOs WindowsLinux 如果未指定任何容器 OS,則 Windows 是預設值。 針對 Windows 容器,容器引擎將會包含在安裝中。 針對 Linux 容器,您必須先安裝容器引擎,才能開始安裝。
Proxy Proxy URL 如果您的裝置需要透過 Proxy 伺服器連線到因特網,請包含此參數。 如需詳細資訊,請參閱設定 IoT Edge 裝置以透過 Proxy 伺服器進行通訊
InvokeWebRequestParameters 參數和值的哈希表 在安裝期間,會提出數個 Web 要求。 使用此欄位來設定這些 Web 要求的參數。 此參數有助於設定 Proxy 伺服器的認證。 如需詳細資訊,請參閱設定 IoT Edge 裝置以透過 Proxy 伺服器進行通訊
OfflineInstallationPath 目錄路徑 如果包含此參數,安裝程式會檢查安裝所需的 IoT Edge cab 和 VC Runtime MSI 檔案列出的目錄。 下載目錄中找不到的任何檔案。 如果這兩個檔案都在目錄中,您可以安裝IoT Edge,而不需要因特網連線。 您也可以使用此參數來使用特定版本。
RestartIfNeeded none 此旗標可讓部署腳本在必要時重新啟動機器,而不提示。

Uninstall-IoTEdge

參數 接受的值 註解
none 如果先前嘗試卸載失敗,此旗標會強制卸載。
RestartIfNeeded none 此旗標可讓卸載腳本在必要時重新啟動機器,而不提示。

下一步

瞭解如何在下列文章中使用下列命令: