Partager via

Scripts PowerShell pour IoT Edge avec conteneurs Windows

S’applique à : icône oui IoT Edge 1.1

Important

IoT Edge 1.1 date de fin de support était le 13 décembre 2022. Consultez la page Politique de support Microsoft pour plus d’informations sur la prise en charge de ce produit, de ce service, de cette technologie ou de cette API. Pour plus d’informations sur la mise à jour vers la dernière version d’IoT Edge, consultez Mettre à jour IoT Edge.

Comprendre les scripts PowerShell qui installent, mettent à jour ou désinstallent IoT Edge sur les appareils Windows.

Les commandes décrites dans cet article proviennent du fichier IoTEdgeSecurityDaemon.ps1 publié avec chaque version d’IoT Edge . La dernière version du script est toujours disponible à aka.ms/iotedge-win.

Vous pouvez exécuter l’une des commandes à l’aide de l’applet de commande Invoke-WebRequest pour accéder à la dernière version du script. Par exemple:

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

Vous pouvez également télécharger ce script, ou une version du script à partir d’une version spécifique, pour exécuter les commandes. Par exemple:

. <path>\IoTEdgeSecurityDaemon.ps1
Deploy-IoTEdge

Le script fourni est signé pour renforcer la sécurité. Vous pouvez vérifier la signature en téléchargeant le script sur votre appareil, puis en exécutant la commande PowerShell suivante :

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

L’état de sortie est valide si la signature est vérifiée.

Deploy-IoTEdge

La commande Deploy-IoTEdge télécharge et déploie le démon de sécurité IoT Edge et ses dépendances. La commande de déploiement accepte ces paramètres communs, entre autres. Pour obtenir la liste complète, utilisez la commande Get-Help Deploy-IoTEdge -full.

Paramètre Valeurs acceptées Commentaires
ContainerOs Windows ou Linux Si aucun système d’exploitation de conteneur n’est spécifié, Windows est la valeur par défaut.

Pour les conteneurs Windows, IoT Edge utilise le moteur de conteneur Moby inclus dans l’installation. Pour les conteneurs Linux, vous devez installer un moteur de conteneur avant de démarrer l’installation.
Procuration Proxy URL Incluez ce paramètre si votre appareil doit passer par un serveur proxy pour accéder à Internet. Pour plus d’informations, voir Configurer un appareil IoT Edge de façon à ce qu’il communique via un serveur proxy.
offlineInstallationPath Chemin du répertoire Si ce paramètre est inclus, le programme d’installation vérifie le répertoire répertorié pour les fichiers MSI IoT Edge cab et VC Runtime requis pour l’installation. Tous les fichiers introuvables dans le répertoire sont téléchargés. Si les deux fichiers se trouvent dans le répertoire, vous pouvez installer IoT Edge sans connexion Internet. Vous pouvez également utiliser ce paramètre pour utiliser une version spécifique.
InvokeWebRequestParameters Table de hachage des paramètres et des valeurs Pendant l’installation, plusieurs requêtes web sont effectuées. Utilisez ce champ pour définir des paramètres pour ces requêtes web. Ce paramètre est utile pour configurer les informations d’identification pour les serveurs proxy. Pour plus d’informations, voir Configurer un appareil IoT Edge de façon à ce qu’il communique via un serveur proxy.
RestartIfNeededed aucun Cet indicateur permet au script de déploiement de redémarrer l’ordinateur sans demander si nécessaire.

Initialize-IoTEdge

La commande Initialize-IoTEdge configure IoT Edge avec la chaîne de connexion de votre appareil et les détails opérationnels. La plupart des informations générées par cette commande sont ensuite stockées dans le fichier iotedge\config.yaml. La commande d’initialisation accepte ces paramètres communs, entre autres. Pour obtenir la liste complète, utilisez la commande Get-Help Initialize-IoTEdge -full.

Paramètre Valeurs acceptées Commentaires
manualConnectionString Aucun paramètre Switch. valeur par défaut. Si aucun type d’approvisionnement n’est spécifié, l’approvisionnement manuel avec une chaîne de connexion est la valeur par défaut.

Déclare que vous fournirez une chaîne de connexion d’appareil pour provisionner l’appareil manuellement.
ManualX509 Aucun paramètre Switch. Si aucun type d’approvisionnement n’est spécifié, l’approvisionnement manuel avec une chaîne de connexion est la valeur par défaut.

Déclare que vous fournirez un certificat d’identité et une clé privée pour approvisionner l’appareil manuellement.
DpsTpm Aucun paramètre Switch. Si aucun type d’approvisionnement n’est spécifié, l’approvisionnement manuel avec une chaîne de connexion est la valeur par défaut.

Déclare que vous fournirez un ID d’étendue DPS (Device Provisioning Service) et l’ID d’inscription de votre appareil à approvisionner via DPS.
DpsSymmetricKey Aucun paramètre Switch. Si aucun type d’approvisionnement n’est spécifié, l’approvisionnement manuel avec une chaîne de connexion est la valeur par défaut.

Déclare que vous fournirez un ID d’étendue DPS (Device Provisioning Service) et l’ID d’inscription de votre appareil à approvisionner via DPS, ainsi qu’une clé symétrique pour l’attestation.
DpsX509 Aucun paramètre Switch. Si aucun type d’approvisionnement n’est spécifié, l’approvisionnement manuel avec une chaîne de connexion est la valeur par défaut.

Déclare que vous fournirez un ID d’étendue DPS (Device Provisioning Service) et l’ID d’inscription de votre appareil à approvisionner via DPS, ainsi qu’un certificat d’identité X.509 et une clé privée pour l’attestation.
DeviceConnectionString Chaîne de connexion à partir d’un appareil IoT Edge inscrit dans un hub IoT, entre guillemets simples obligatoire pour l’approvisionnement manuel avec une chaîne de connexion. Si vous ne fournissez pas de chaîne de connexion dans les paramètres de script, vous en êtes invité à en fournir une.
IotHubHostName Nom d’hôte du hub IoT auquel un appareil se connecte. obligatoire pour l’approvisionnement manuel avec des certificats X.509. Prend le format {hub name}.azure-devices.net.
DeviceId ID d’appareil à partir d’une identité d’appareil inscrite dans IoT Hub. obligatoire pour l’approvisionnement manuel avec des certificats X.509.
ScopeId ID d’étendue d’une instance du service Device Provisioning associé à votre IoT Hub. obligatoire pour l’approvisionnement DPS. Si vous ne fournissez pas d’ID d’étendue dans les paramètres de script, vous en êtes invité à en fournir un.
RegistrationId ID d’inscription généré par votre appareil obligatoire pour l’approvisionnement DPS si vous utilisez un module TPM ou une attestation de clé symétrique. facultatif si vous utilisez l’attestation de certificat X.509.
X509IdentityCertificate Chemin d’URI du certificat d’identité de l’appareil X.509 sur l’appareil. obligatoire pour l’approvisionnement manuel ou DPS si vous utilisez l’attestation de certificat X.509.
X509IdentityPrivateKey Chemin d’URI de la clé de certificat d’identité de l’appareil X.509 sur l’appareil. obligatoire pour l’approvisionnement manuel ou DPS si vous utilisez l’attestation de certificat X.509.
SymmetricKey Clé symétrique utilisée pour approvisionner l’identité de l’appareil IoT Edge lors de l’utilisation de DPS obligatoire pour l’approvisionnement DPS si vous utilisez l’attestation de clé symétrique.
ContainerOs Windows ou Linux Si aucun système d’exploitation de conteneur n’est spécifié, Windows est la valeur par défaut.

Pour les conteneurs Windows, IoT Edge utilise le moteur de conteneur Moby inclus dans l’installation. Pour les conteneurs Linux, vous devez installer un moteur de conteneur avant de démarrer l’installation.
DeviceCACertificate Chemin d’URI du certificat d’autorité de certification de l’appareil X.509 sur l’appareil. Peut également être configuré dans le fichier C:\ProgramData\iotedge\config.yaml. Pour plus d’informations, consultez Gérer les certificats sur un appareil IoT Edge.
DeviceCAPrivateKey Chemin d’URI de la clé privée de l’autorité de certification de l’appareil X.509 sur l’appareil. Peut également être configuré dans le fichier C:\ProgramData\iotedge\config.yaml. Pour plus d’informations, consultez Gérer les certificats sur un appareil IoT Edge.
InvokeWebRequestParameters Table de hachage des paramètres et des valeurs Pendant l’installation, plusieurs requêtes web sont effectuées. Utilisez ce champ pour définir des paramètres pour ces requêtes web. Ce paramètre est utile pour configurer les informations d’identification pour les serveurs proxy. Pour plus d’informations, voir Configurer un appareil IoT Edge de façon à ce qu’il communique via un serveur proxy.
AgentImage URI de l’image de l’agent IoT Edge Par défaut, une nouvelle installation IoT Edge utilise la dernière balise propagée pour l’image de l’agent IoT Edge. Utilisez ce paramètre pour définir une balise spécifique pour la version de l’image ou pour fournir votre propre image d’agent. Pour plus d’informations, consultez Comprendre les balises IoT Edge.
Nom d’utilisateur Nom d’utilisateur du registre de conteneurs Utilisez ce paramètre uniquement si vous définissez le paramètre -AgentImage sur un conteneur dans un registre privé. Fournissez un nom d’utilisateur avec accès au Registre.
Mot de passe Chaîne de mot de passe sécurisée Utilisez ce paramètre uniquement si vous définissez le paramètre -AgentImage sur un conteneur dans un registre privé. Indiquez le mot de passe pour accéder au Registre.

Update-IoTEdge

Paramètre Valeurs acceptées Commentaires
ContainerOs Windows ou Linux Si aucun système d’exploitation de conteneur n’est spécifié, Windows est la valeur par défaut. Pour les conteneurs Windows, un moteur de conteneur sera inclus dans l’installation. Pour les conteneurs Linux, vous devez installer un moteur de conteneur avant de démarrer l’installation.
Procuration Proxy URL Incluez ce paramètre si votre appareil doit passer par un serveur proxy pour accéder à Internet. Pour plus d’informations, voir Configurer un appareil IoT Edge de façon à ce qu’il communique via un serveur proxy.
InvokeWebRequestParameters Table de hachage des paramètres et des valeurs Pendant l’installation, plusieurs requêtes web sont effectuées. Utilisez ce champ pour définir des paramètres pour ces requêtes web. Ce paramètre est utile pour configurer les informations d’identification pour les serveurs proxy. Pour plus d’informations, voir Configurer un appareil IoT Edge de façon à ce qu’il communique via un serveur proxy.
offlineInstallationPath Chemin du répertoire Si ce paramètre est inclus, le programme d’installation vérifie le répertoire répertorié pour les fichiers MSI IoT Edge cab et VC Runtime requis pour l’installation. Tous les fichiers introuvables dans le répertoire sont téléchargés. Si les deux fichiers se trouvent dans le répertoire, vous pouvez installer IoT Edge sans connexion Internet. Vous pouvez également utiliser ce paramètre pour utiliser une version spécifique.
RestartIfNeededed aucun Cet indicateur permet au script de déploiement de redémarrer l’ordinateur sans demander si nécessaire.

Uninstall-IoTEdge

Paramètre Valeurs acceptées Commentaires
Force aucun Cet indicateur force la désinstallation si la tentative précédente de désinstallation a échoué.
RestartIfNeededed aucun Cet indicateur permet au script de désinstallation de redémarrer l’ordinateur sans demander si nécessaire.

Étapes suivantes

Découvrez comment utiliser ces commandes dans l’article suivant :

  • Last updated on