You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Azure IoT Edge runtime is what turns a device into an IoT Edge device. The runtime can be deployed on devices as small as a Raspberry Pi or as large as an industrial server. Once a device is configured with the IoT Edge runtime, you can start deploying business logic to it from the cloud.
16
+
The Azure IoT Edge runtime turns a device into an IoT Edge device. Deploy the runtime on devices as small as a Raspberry Pi or as large as an industrial server. After you set up the IoT Edge runtime, deploy business logic to the device from the cloud.
17
17
18
-
To learn more about how the IoT Edge runtime works and what components are included, see [Understand the Azure IoT Edge runtime and its architecture](iot-edge-runtime.md).
18
+
To learn more about how the IoT Edge runtime works and its components, see [understand the Azure IoT Edge runtime and its architecture](iot-edge-runtime.md).
19
19
20
-
This article lists the steps to deploy an Ubuntu virtual machine with the Azure IoT Edge runtime installed and configured using a presupplied device connection string. The deployment is accomplished using a [cloud-init](/azure/virtual-machines/linux/using-cloud-init) based [Azure Resource Manager template](../azure-resource-manager/templates/overview.md)maintained in the [iotedge-vm-deploy](https://github.com/Azure/iotedge-vm-deploy) project repository.
20
+
This article lists the steps to deploy an Ubuntu virtual machine with the Azure IoT Edge runtime installed and configured using a provided device connection string. The deployment uses a [cloud-init](/azure/virtual-machines/linux/using-cloud-init) based [Azure Resource Manager template](../azure-resource-manager/templates/overview.md)from the [iotedge-vm-deploy](https://github.com/Azure/iotedge-vm-deploy) project repository.
21
21
22
-
On first boot, the virtual machine [installs the latest version of the Azure IoT Edge runtime via cloud-init](https://github.com/Azure/iotedge-vm-deploy/blob/main/cloud-init.txt). It also sets a supplied connection string before the runtime starts, allowing you to easily configure and connect the IoT Edge device without the need to start an SSH or remote desktop session.
22
+
On first boot, the virtual machine [installs the latest version of the Azure IoT Edge runtime using cloud-init](https://github.com/Azure/iotedge-vm-deploy/blob/main/cloud-init.txt). It also sets a provided connection string before the runtime starts, so you can quickly set up and connect the IoT Edge device without starting an SSH or remote desktop session.
23
23
24
24
## Deploy using Deploy to Azure Button
25
25
26
-
The [Deploy to Azure Button](../azure-resource-manager/templates/deploy-to-azure-button.md)allows for streamlined deployment of [Azure Resource Manager templates](../azure-resource-manager/templates/overview.md)maintained on GitHub.
27
-
This section demonstrates usage of the Deploy to Azure Button contained in the [iotedge-vm-deploy](https://github.com/Azure/iotedge-vm-deploy) project repository.
26
+
The [Deploy to Azure Button](../azure-resource-manager/templates/deploy-to-azure-button.md)lets you quickly deploy [Azure Resource Manager templates](../azure-resource-manager/templates/overview.md)from GitHub.
27
+
This section shows how to use the **Deploy to Azure** button in the [iotedge-vm-deploy](https://github.com/Azure/iotedge-vm-deploy) project repository.
28
28
29
-
1.You will deploy an Azure IoT Edgeenabled Linux VM using the iotedge-vm-deploy Azure Resource Manager template. To begin, select the following button:
29
+
1.Deploy an Azure IoT Edge-enabled Linux VM by using the iotedge-vm-deploy Azure Resource Manager template. To start, select the following button:
30
30
31
-
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fazure%2Fiotedge-vm-deploy%2Fmain%2FedgeDeploy.json)
31
+
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fazure%2Fiotedge-vm-deploy%2Fmain%2FedgeDeploy.json)
32
32
33
-
1.On the newly launched window, fill in the available form fields:
33
+
1.In the new window, enter values for the available form fields:
34
34
35
-
> [!div class="mx-imgBorder"]
35
+
:::image type="content" source="./media/how-to-install-iot-edge-ubuntuvm/iotedge-vm-deploy-ubuntu2004.png" alt-text="Screenshot showing the iotedge-vm-deploy template." lightbox="./media/how-to-install-iot-edge-ubuntuvm/iotedge-vm-deploy-ubuntu2004.png":::
36
36
37
-
> [](./media/how-to-install-iot-edge-ubuntuvm/iotedge-vm-deploy-ubuntu2004.png)
38
37
39
38
| Field | Description |
40
39
| --------- | ----------- |
41
40
|**Subscription**| The active Azure subscription to deploy the virtual machine into. |
42
-
|**Resource group**| An existing or newly created Resource Group to contain the virtual machine and it's associated resources. |
43
-
|**Region**| The [geographic region](https://azure.microsoft.com/global-infrastructure/locations/)to deploy the virtual machine into, this value defaults to the location of the selected Resource Group. |
44
-
|**DNS Label Prefix**| A required value of your choosing that is used to prefix the hostname of the virtual machine. |
45
-
|**Admin Username**| A username that is provided root privileges on deployment. |
46
-
|**Device Connection String**| A [device connection string](./how-to-provision-single-device-linux-symmetric.md#view-registered-devices-and-retrieve-provisioning-information) for a device that was created within your intended [IoT Hub](../iot-hub/about-iot-hub.md). |
47
-
|**VM Size**| The [size](../cloud-services/cloud-services-sizes-specs.md) of the virtual machine to be deployed. |
48
-
|**Ubuntu OS Version**| The version of the Ubuntu OS to be installed on the base virtual machine. |
49
-
|**Authentication Type**| Choose **sshPublicKey** or **password**depending on your preference. |
50
-
|**Admin Password or Key**| The value of the SSH Public Key or the value of the password depending on the choice of Authentication Type. |
41
+
|**Resource group**| An existing or new resource group to contain the virtual machine and its associated resources. |
42
+
|**Region**| The [geographic region](https://azure.microsoft.com/global-infrastructure/locations/)where you deploy the virtual machine. This value defaults to the location of the selected resource group. |
43
+
|**DNS Label Prefix**| A required value you choose to prefix the hostname of the virtual machine. |
44
+
|**Admin Username**| A username with root privileges on deployment. |
45
+
|**Device Connection String**| A [device connection string](./how-to-provision-single-device-linux-symmetric.md#view-registered-devices-and-retrieve-provisioning-information) for a device you created in your [IoT hub](../iot-hub/about-iot-hub.md). |
46
+
|**VM Size**| The [size](../cloud-services/cloud-services-sizes-specs.md) of the virtual machine to deploy. |
47
+
|**Ubuntu OS Version**| The version of Ubuntu OS to install on the base virtual machine. |
48
+
|**Authentication Type**| Choose **sshPublicKey** or **password**based on your preference. |
49
+
|**Admin Password or Key**| The SSH public key or password value, depending on the authentication type you choose. |
51
50
52
-
Select `Next : Review + create` to review the terms and select **Create** to begin the deployment.
51
+
Select `Next : Review + create` to review the terms, and then select **Create** to start the deployment.
53
52
54
-
1.Verify that the deployment completed successfully. A virtual machine resource is deployed into the selected resource group. Take note of the machine name, this should be in the format `vm-0000000000000`. Also, take note of the associated **DNS Name**, which should be in the format `<dnsLabelPrefix>`.`<location>`.cloudapp.azure.com.
53
+
1.Check that the deployment completes successfully. The virtual machine resource is deployed into the selected resource group. Note the machine name, which is in the format `vm-0000000000000`. Also, note the associated **DNS Name**, which is in the format `<dnsLabelPrefix>`.`<location>`.cloudapp.azure.com.
55
54
56
-
The **DNS Name**can be obtained from the **Overview** section of the newly deployed virtual machine within the Azure portal.
55
+
You can find the **DNS Name**in the **Overview** section of the new virtual machine in the Azure portal.
57
56
58
-
> [!div class="mx-imgBorder"]
59
-
> [](./media/how-to-install-iot-edge-ubuntuvm/iotedge-vm-dns-name.png)
57
+
:::image type="content" source="./media/how-to-install-iot-edge-ubuntuvm/iotedge-vm-dns-name.png" alt-text="Screenshot showing the dns name of the IoT Edge VM." lightbox="./media/how-to-install-iot-edge-ubuntuvm/iotedge-vm-dns-name.png":::
60
58
61
59
1. If you want to SSH into this VM after setup, use the associated **DNS Name** with the command:
62
60
`ssh <adminUsername>@<DNS_Name>`
@@ -82,9 +80,9 @@ The [Deploy to Azure Button](../azure-resource-manager/templates/deploy-to-azure
82
80
az account list --output table
83
81
```
84
82
85
-
1. Copy the SubscriptionID field for the subscription you'd like to use.
83
+
1. Copy the SubscriptionID field for the subscription you want to use.
86
84
87
-
1. Set your working subscription with the ID that you copied:
85
+
1. Set your working subscription with the ID you copied:
88
86
89
87
```azurecli-interactive
90
88
az account set -s <SubscriptionId>
@@ -98,7 +96,7 @@ The [Deploy to Azure Button](../azure-resource-manager/templates/deploy-to-azure
98
96
99
97
1. Create a new virtual machine:
100
98
101
-
To use an **authenticationType** of `password`, see the following example:
99
+
To use an **authenticationType** of `password`, use the following example:
102
100
103
101
```azurecli-interactive
104
102
az deployment group create \
@@ -128,9 +126,9 @@ The [Deploy to Azure Button](../azure-resource-manager/templates/deploy-to-azure
1. Verify that the deployment completed successfully. A virtual machine resource should be deployed into the selected resource group. Take note of the machine name, this should be in the format `vm-0000000000000`. Also, take note of the associated **DNS Name**, which should be in the format `<dnsLabelPrefix>`.`<location>`.cloudapp.azure.com.
129
+
1. Verify that the deployment completed successfully. A virtual machine resource should be deployed into the selected resource group. Take note of the machine name, it's in the format `vm-0000000000000`. Also, take note of the associated **DNS Name**, which is in the format `<dnsLabelPrefix>`.`<location>`.cloudapp.azure.com.
132
130
133
-
The **DNS Name**can be obtained from the JSON-formatted output of the previous step, within the **outputs** section as part of the **public SSH** entry. The value of this entry can be used to SSH into to the newly deployed machine.
131
+
You can get the **DNS Name** from the JSON-formatted output of the previous step, in the **outputs** section as part of the **public SSH** entry. Use this value to SSH into the newly deployed machine.
134
132
135
133
```bash
136
134
"outputs": {
@@ -141,20 +139,19 @@ The [Deploy to Azure Button](../azure-resource-manager/templates/deploy-to-azure
141
139
}
142
140
```
143
141
144
-
The **DNS Name**can also be obtained from the **Overview** section of the newly deployed virtual machine within the Azure portal.
142
+
You can also get the **DNS Name** from the **Overview** section of the newly deployed virtual machine in the Azure portal.
145
143
146
-
> [!div class="mx-imgBorder"]
147
-
> [](./media/how-to-install-iot-edge-ubuntuvm/iotedge-vm-dns-name.png)
144
+
:::image type="content" source="./media/how-to-install-iot-edge-ubuntuvm/iotedge-vm-dns-name.png" alt-text="Screenshot showing the dns name of the IoT Edge VM." lightbox="./media/how-to-install-iot-edge-ubuntuvm/iotedge-vm-dns-name.png":::
148
145
149
146
1. If you want to SSH into this VM after setup, use the associated **DNS Name** with the command:
150
147
`ssh <adminUsername>@<DNS_Name>`
151
148
152
149
## Next steps
153
150
154
-
Now that you have an IoT Edge device provisioned with the runtime installed, you can [deploy IoT Edge modules](how-to-deploy-modules-portal.md).
151
+
Now that you provisioned an IoT Edge device with the runtime installed, deploy [IoT Edge modules](how-to-deploy-modules-portal.md).
155
152
156
-
If you are having problems with the IoT Edge runtime installing properly, check out the [troubleshooting](troubleshoot.md) page.
153
+
If you have problems installing the IoT Edge runtime, see the [troubleshooting](troubleshoot.md) page.
157
154
158
-
To update an existing installation to the newest version of IoT Edge, see [Update the IoT Edge security daemon and runtime](how-to-update-iot-edge.md).
155
+
To update an existing installation to the latest version of IoT Edge, see [Update the IoT Edge security daemon and runtime](how-to-update-iot-edge.md).
159
156
160
-
If you'd like to open up ports to access the VM through SSH or other inbound connections, refer to the Azure Virtual Machines documentation on [opening up ports and endpoints to a Linux VM](/azure/virtual-machines/linux/nsg-quickstart).
157
+
If you want to open ports to access the VM through SSH or other inbound connections, see the Azure Virtual Machines documentation on [opening ports and endpoints to a Linux VM](/azure/virtual-machines/linux/nsg-quickstart).
0 commit comments