Stop-Service iotedge
to stop any running IoT Edge modules before using these power states. https://yellowscribe680.weebly.com/blog/spelling-checker-free-download-for-mac.HostName={IoT hub name}.azure-devices.net;DeviceId={device name};SharedAccessKey={key}
-OfflineInstallationPath
parameter as part of the Deploy-IoTEdge command and provide the absolute path to the file directory. For example,Get-Help Update-IoTEdge -full
or refer to all installation parameters.Get-Help Uninstall-IoTEdge -full
.Get-Help Deploy-IoTEdge -full
.Parameter | Accepted values | Comments |
---|---|---|
ContainerOs | Windows or Linux | If no container operating system is specified, Windows is the default value. For Windows containers, IoT Edge uses the moby container engine included in the installation. For Linux containers, you need to install a container engine before starting the installation. |
Proxy | Proxy URL | Include this parameter if your device needs to go through a proxy server to reach the internet. For more information, see Configure an IoT Edge device to communicate through a proxy server. |
OfflineInstallationPath | Directory path | If this parameter is included, the installer will check the listed directory for the IoT Edge cab and VC Runtime MSI files required for installation. Any files not found in the directory are downloaded. If both files are in the directory, you can install IoT Edge without an internet connection. You can also use this parameter to use a specific version. |
InvokeWebRequestParameters | Hashtable of parameters and values | During installation, several web requests are made. Use this field to set parameters for those web requests. This parameter is useful to configure credentials for proxy servers. For more information, see Configure an IoT Edge device to communicate through a proxy server. |
RestartIfNeeded | none | This flag allows the deployment script to restart the machine without prompting, if necessary. |
Get-Help Initialize-IoTEdge -full
.Parameter | Accepted values | Comments |
---|---|---|
Manual | None | Switch parameter. If no provisioning type is specified, manual is the default value. Declares that you will provide a device connection string to provision the device manually |
Dps | None | Switch parameter. If no provisioning type is specified, manual is the default value. Declares that you will provide a Device Provisioning Service (DPS) scope ID and your device's Registration ID to provision through DPS. |
DeviceConnectionString | A connection string from an IoT Edge device registered in an IoT Hub, in single quotes | Required for manual installation. If you don't provide a connection string in the script parameters, you will be prompted for one during installation. |
ScopeId | A scope ID from an instance of Device Provisioning Service associated with your IoT Hub. | Required for DPS installation. If you don't provide a scope ID in the script parameters, you will be prompted for one during installation. |
RegistrationId | A registration ID generated by your device | Required for DPS installation if using TPM or symmetric key attestation. |
SymmetricKey | The symmetric key used to provision the IoT Edge device identity when using DPS | Required for DPS installation if using symmetric key attestation. |
ContainerOs | Windows or Linux | If no container operating system is specified, Windows is the default value. For Windows containers, IoT Edge uses the moby container engine included in the installation. For Linux containers, you need to install a container engine before starting the installation. |
InvokeWebRequestParameters | Hashtable of parameters and values | During installation, several web requests are made. Use this field to set parameters for those web requests. This parameter is useful to configure credentials for proxy servers. For more information, see Configure an IoT Edge device to communicate through a proxy server. |
AgentImage | IoT Edge agent image URI | By default, a new IoT Edge installation uses the latest rolling tag for the IoT Edge agent image. Use this parameter to set a specific tag for the image version, or to provide your own agent image. For more information, see Understand IoT Edge tags. |
Username | Container registry username | Use this parameter only if you set the -AgentImage parameter to a container in a private registry. Provide a username with access to the registry. |
Password | Secure password string | Use this parameter only if you set the -AgentImage parameter to a container in a private registry. Provide the password to access the registry. |
Parameter | Accepted values | Comments |
---|---|---|
ContainerOs | Windows or Linux | If no container OS is specified, Windows is the default value. For Windows containers, a container engine will be included in the installation. For Linux containers, you need to install a container engine before starting the installation. |
Proxy | Proxy URL | Include this parameter if your device needs to go through a proxy server to reach the internet. For more information, see Configure an IoT Edge device to communicate through a proxy server. |
InvokeWebRequestParameters | Hashtable of parameters and values | During installation, several web requests are made. Use this field to set parameters for those web requests. This parameter is useful to configure credentials for proxy servers. For more information, see Configure an IoT Edge device to communicate through a proxy server. |
OfflineInstallationPath | Directory path | If this parameter is included, the installer will check the listed directory for the IoT Edge cab and VC Runtime MSI files required for installation. Any files not found in the directory are downloaded. If both files are in the directory, you can install IoT Edge without an internet connection. You can also use this parameter to use a specific version. |
RestartIfNeeded | none | This flag allows the deployment script to restart the machine without prompting, if necessary. |
Parameter | Accepted values | Comments |
---|---|---|
Force | none | This flag forces the uninstallation in case the previous attempt to uninstall was unsuccessful. |
RestartIfNeeded | none | This flag allows the uninstall script to restart the machine without prompting, if necessary. |