Skrypty programu PowerShell dla IoT Edge z kontenerami systemu Windows
Dotyczy ikony:
IoT Edge 1.1
Ważne
IoT Edge 1.1 data zakończenia wsparcia technicznego wynosiła 13 grudnia 2022 r. Zapoznaj się z cyklem życia produktów firmy Microsoft, aby uzyskać informacje na temat sposobu obsługi tego produktu lub interfejsu API albo tej usługi lub technologii. Aby uzyskać więcej informacji na temat aktualizowania do najnowszej wersji IoT Edge, zobacz Update IoT Edge.
Poznaj skrypty programu PowerShell, które instalują, aktualizują lub odinstalowują IoT Edge na urządzeniach z systemem Windows.
Polecenia opisane w tym artykule pochodzą z pliku wydanego przy każdym wydaniuIoTEdgeSecurityDaemon.ps1 IoT Edge. Najnowsza wersja skryptu jest zawsze dostępna w aka.ms/iotedge-win.
Aby uzyskać dostęp do najnowszej wersji skryptu, możesz uruchomić dowolne polecenia przy użyciu Invoke-WebRequest polecenia cmdlet . Przykład:
. {Invoke-WebRequest -useb https://aka.ms/iotedge-win} | Invoke-Expression; `
Deploy-IoTEdge
Możesz również pobrać ten skrypt lub wersję skryptu z określonej wersji, aby uruchomić polecenia. Przykład:
. <path>\IoTEdgeSecurityDaemon.ps1
Deploy-IoTEdge
Podany skrypt jest podpisany w celu zwiększenia bezpieczeństwa. Podpis możesz zweryfikować, pobierając skrypt na urządzenie, a następnie uruchamiając następujące polecenie programu PowerShell:
Get-AuthenticodeSignature "C:\<path>\IotEdgeSecurityDaemon.ps1"
Stan danych wyjściowych jest prawidłowy , jeśli podpis jest zweryfikowany.
Deploy-IoTEdge
Polecenie Deploy-IoTEdge pobiera i wdraża demona zabezpieczeń IoT Edge oraz jego zależności. Polecenie wdrożenia akceptuje między innymi te typowe parametry. Aby uzyskać pełną listę, użyj polecenia Get-Help Deploy-IoTEdge -full.
| Parametr | Dopuszczalne wartości | Komentarze |
|---|---|---|
| Kontenery | Windows lub Linux | Jeśli nie określono żadnego systemu operacyjnego kontenera, system Windows jest wartością domyślną. W przypadku kontenerów systemu Windows IoT Edge używa aparatu kontenera Moby uwzględnionego w instalacji. W przypadku kontenerów systemu Linux należy zainstalować aparat kontenera przed rozpoczęciem instalacji. |
| Proxy | Proxy URL | Dołącz ten parametr, jeśli urządzenie musi przejść przez serwer proxy, aby uzyskać dostęp do Internetu. Aby uzyskać więcej informacji, zobacz Konfigurowanie urządzenia IoT Edge do komunikowania się za pośrednictwem serwera proxy. |
| OfflineInstallationPath | Ścieżka katalogu | Jeśli ten parametr zostanie dołączony, instalator sprawdzi katalog na liście dla plików cab IoT Edge i VC Runtime MSI wymaganych do instalacji. Wszystkie pliki, których nie znaleziono w katalogu, są pobierane. Jeśli oba pliki znajdują się w katalogu, możesz zainstalować IoT Edge bez połączenia internetowego. Możesz również użyć tego parametru, aby użyć określonej wersji. |
| InvokeWebRequestParameters | Tabela skrótów parametrów i wartości | Podczas instalacji jest wysyłanych kilka żądań internetowych. To pole służy do ustawiania parametrów dla tych żądań internetowych. Ten parametr jest przydatny do konfigurowania poświadczeń dla serwerów proxy. Aby uzyskać więcej informacji, zobacz Konfigurowanie urządzenia IoT Edge do komunikowania się za pośrednictwem serwera proxy. |
| RestartIfNeeded | brak | Ta flaga umożliwia skryptowi wdrażania ponowne uruchomienie maszyny bez monitowania, jeśli to konieczne. |
Initialize-IoTEdge
Polecenie Initialize-IoTEdge konfiguruje IoT Edge przy użyciu parametrów połączenia urządzenia i szczegółów operacyjnych. Większość informacji generowanych przez to polecenie jest następnie przechowywana w pliku iotedge\config.yaml. Polecenie inicjowania akceptuje między innymi te typowe parametry. Aby uzyskać pełną listę, użyj polecenia Get-Help Initialize-IoTEdge -full.
| Parametr | Dopuszczalne wartości | Komentarze |
|---|---|---|
| ManualConnectionString | Brak | Przełącznik parametru. Wartość domyślna. Jeśli nie określono typu aprowizacji, ręczna aprowizacja przy użyciu parametrów połączenia jest wartością domyślną. Deklaruje, że podasz parametry połączenia urządzenia w celu ręcznego aprowizowania urządzenia. |
| ManualX509 | Brak | Przełącznik parametru. Jeśli nie określono typu aprowizacji, ręczna aprowizacja przy użyciu parametrów połączenia jest wartością domyślną. Deklaruje, że dostarczysz certyfikat tożsamości i klucz prywatny w celu ręcznego aprowizowania urządzenia. |
| DpsTpm | Brak | Przełącznik parametru. Jeśli nie określono typu aprowizacji, ręczna aprowizacja przy użyciu parametrów połączenia jest wartością domyślną. Deklaruje, że podasz identyfikator zakresu usługi Device Provisioning Service (DPS) i identyfikator rejestracji urządzenia do aprowizacji za pośrednictwem usługi DPS. |
| DpsSymmetricKey | Brak | Przełącznik parametru. Jeśli nie określono typu aprowizacji, ręczna aprowizacja przy użyciu parametrów połączenia jest wartością domyślną. Deklaruje, że podasz identyfikator zakresu usługi Device Provisioning Service (DPS) i identyfikator rejestracji urządzenia do aprowizacji za pośrednictwem usługi DPS wraz z kluczem symetrycznym na potrzeby zaświadczania. |
| DpsX509 | Brak | Przełącznik parametru. Jeśli nie określono typu aprowizacji, ręczna aprowizacja przy użyciu parametrów połączenia jest wartością domyślną. Deklaruje, że podasz identyfikator zakresu usługi Device Provisioning Service (DPS) i identyfikator rejestracji urządzenia do aprowizacji za pośrednictwem usługi DPS wraz z certyfikatem tożsamości X.509 i kluczem prywatnym na potrzeby zaświadczania. |
| DeviceConnectionString | Parametry połączenia z urządzenia IoT Edge zarejestrowanego w IoT Hub w apostrofach | Wymagane do ręcznej aprowizacji z parametrami połączenia. Jeśli nie podasz parametrów połączenia w parametrach skryptu, zostanie wyświetlony monit o podanie parametrów. |
| IotHubHostName | Nazwa hosta centrum IoT, z którą łączy się urządzenie. | Wymagane do ręcznej aprowizacji przy użyciu certyfikatów X.509. Przyjmuje format {hub name}.azure-devices.net. |
| Deviceid | Identyfikator urządzenia z zarejestrowanej tożsamości urządzenia w IoT Hub. | Wymagane do ręcznej aprowizacji przy użyciu certyfikatów X.509. |
| Idzakresu | Identyfikator zakresu z wystąpienia usługi Device Provisioning Service skojarzonego z IoT Hub. | Wymagane do aprowizacji usługi DPS. Jeśli nie podasz identyfikatora zakresu w parametrach skryptu, zostanie wyświetlony monit o jego podanie. |
| Identyfikator rejestracji | Identyfikator rejestracji wygenerowany przez urządzenie | Wymagane do aprowizacji usługi DPS w przypadku korzystania z modułu TPM lub zaświadczania klucza symetrycznego. Opcjonalnie , jeśli używasz zaświadczania certyfikatu X.509. |
| X509IdentityCertificate | Ścieżka identyfikatora URI do certyfikatu tożsamości urządzenia X.509 na urządzeniu. | Wymagane w przypadku aprowizacji ręcznej lub DPS w przypadku korzystania z zaświadczania certyfikatu X.509. |
| X509IdentityPrivateKey | Ścieżka identyfikatora URI do klucza certyfikatu tożsamości urządzenia X.509 na urządzeniu. | Wymagane w przypadku aprowizacji ręcznej lub DPS w przypadku korzystania z zaświadczania certyfikatu X.509. |
| Symmetrickey | Klucz symetryczny używany do aprowizacji tożsamości urządzenia IoT Edge podczas korzystania z usługi DPS | Wymagane do aprowizacji usługi DPS w przypadku korzystania z zaświadczania klucza symetrycznego. |
| Kontenery | Windows lub Linux | Jeśli nie określono żadnego systemu operacyjnego kontenera, system Windows jest wartością domyślną. W przypadku kontenerów systemu Windows IoT Edge używa aparatu kontenera Moby uwzględnionego w instalacji. W przypadku kontenerów systemu Linux należy zainstalować aparat kontenera przed rozpoczęciem instalacji. |
| DeviceCACertificate | Ścieżka identyfikatora URI do certyfikatu urzędu certyfikacji urządzenia X.509 na urządzeniu. | Można również skonfigurować w C:\ProgramData\iotedge\config.yaml pliku . Aby uzyskać więcej informacji, zobacz Zarządzanie certyfikatami na urządzeniu IoT Edge. |
| DeviceCAPrivateKey | Ścieżka identyfikatora URI do klucza prywatnego urzędu certyfikacji urządzenia X.509 na urządzeniu. | Można również skonfigurować w C:\ProgramData\iotedge\config.yaml pliku . Aby uzyskać więcej informacji, zobacz Zarządzanie certyfikatami na urządzeniu IoT Edge. |
| InvokeWebRequestParameters | Tabela skrótów parametrów i wartości | Podczas instalacji jest wysyłanych kilka żądań internetowych. To pole służy do ustawiania parametrów dla tych żądań internetowych. Ten parametr jest przydatny do konfigurowania poświadczeń dla serwerów proxy. Aby uzyskać więcej informacji, zobacz Konfigurowanie urządzenia IoT Edge do komunikowania się za pośrednictwem serwera proxy. |
| AgentImage | Identyfikator URI obrazu agenta IoT Edge | Domyślnie nowa instalacja IoT Edge używa najnowszego tagu kroczącego dla obrazu agenta IoT Edge. Użyj tego parametru, aby ustawić określony tag dla wersji obrazu lub udostępnić własny obraz agenta. Aby uzyskać więcej informacji, zobacz Omówienie tagów IoT Edge. |
| Nazwa użytkownika | Nazwa użytkownika rejestru kontenerów | Użyj tego parametru tylko wtedy, gdy ustawisz parametr -AgentImage na kontener w rejestrze prywatnym. Podaj nazwę użytkownika z dostępem do rejestru. |
| Password (Hasło) | Ciąg bezpiecznego hasła | Użyj tego parametru tylko wtedy, gdy ustawisz parametr -AgentImage na kontener w rejestrze prywatnym. Podaj hasło, aby uzyskać dostęp do rejestru. |
Update-IoTEdge
| Parametr | Dopuszczalne wartości | Komentarze |
|---|---|---|
| Kontenery | Windows lub Linux | Jeśli nie określono systemu operacyjnego kontenera, system Windows jest wartością domyślną. W przypadku kontenerów systemu Windows aparat kontenera zostanie uwzględniony w instalacji. W przypadku kontenerów systemu Linux należy zainstalować aparat kontenera przed rozpoczęciem instalacji. |
| Proxy | Proxy URL | Dołącz ten parametr, jeśli urządzenie musi przejść przez serwer proxy, aby uzyskać dostęp do Internetu. Aby uzyskać więcej informacji, zobacz Konfigurowanie urządzenia IoT Edge do komunikowania się za pośrednictwem serwera proxy. |
| InvokeWebRequestParameters | Tabela skrótów parametrów i wartości | Podczas instalacji jest wysyłanych kilka żądań internetowych. To pole służy do ustawiania parametrów dla tych żądań internetowych. Ten parametr jest przydatny do konfigurowania poświadczeń dla serwerów proxy. Aby uzyskać więcej informacji, zobacz Konfigurowanie urządzenia IoT Edge do komunikowania się za pośrednictwem serwera proxy. |
| OfflineInstallationPath | Ścieżka katalogu | Jeśli ten parametr zostanie dołączony, instalator sprawdzi katalog na liście dla plików cab IoT Edge i VC Runtime MSI wymaganych do instalacji. Wszystkie pliki, których nie znaleziono w katalogu, są pobierane. Jeśli oba pliki znajdują się w katalogu, możesz zainstalować IoT Edge bez połączenia internetowego. Możesz również użyć tego parametru, aby użyć określonej wersji. |
| RestartIfNeeded | brak | Ta flaga umożliwia skryptowi wdrażania ponowne uruchomienie maszyny bez monitowania, jeśli to konieczne. |
Uninstall-IoTEdge
| Parametr | Dopuszczalne wartości | Komentarze |
|---|---|---|
| Force | brak | Ta flaga wymusza odinstalowanie w przypadku, gdy poprzednia próba odinstalowania nie powiodła się. |
| RestartIfNeeded | brak | Ta flaga umożliwia skryptowi odinstalowywania ponowne uruchomienie maszyny bez monitowania, jeśli to konieczne. |
Następne kroki
Dowiedz się, jak używać tych poleceń w następującym artykule: