Skip to content

Commit 7378922

Browse files
authored
Merge pull request #47977 from kgremban/aug1-tutorials
Review Edge tutorials for MVC standards
2 parents 83813cd + c0c9614 commit 7378922

10 files changed

+124
-63
lines changed

articles/iot-edge/quickstart-linux.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,37 +41,32 @@ Add the Azure IoT extension to the cloud shell instance.
4141
```azurecli-interactive
4242
az extension add --name azure-cli-iot-ext
4343
```
44-
44+
4545
## Prerequisites
4646

47-
This quickstart uses a Linux machine as an IoT Edge device. If you don't have one available for testing, you can create one using the Azure CLI.
47+
Cloud resources:
4848

49-
Create a new resource group. You can use this resource group for the other Azure resources that you create in this quickstart, for easy management.
49+
* A resource group to manage all the resources you use in this quickstart.
5050

5151
```azurecli-interactive
5252
az group create --name IoTEdgeResources --location westus
5353
```
5454

55-
Create the virtual machine. You don't need a very large virtual machine to test IoT Edge. A size like **B1ms** is sufficient.
55+
* A Linux virtual machine to act as your IoT Edge device.
5656

5757
```azurecli-interactive
5858
az vm create --resource-group IoTEdgeResources --name EdgeVM --image Canonical:UbuntuServer:16.04-LTS:latest --admin-username azureuser --generate-ssh-keys --size Standard_B1ms
5959
```
6060

6161
## Create an IoT hub
6262

63-
Start the quickstart by creating your IoT Hub in the Azure portal.
63+
Start the quickstart by creating your IoT Hub with Azure CLI.
64+
6465
![Create IoT Hub][3]
6566

6667
The free level of IoT Hub works for this quickstart. If you've used IoT Hub in the past and already have a free hub created, you can use that IoT hub. Each subscription can only have one free IoT hub.
6768

68-
1. In the Azure cloud shell, create a resource group if you didn't as part of the prerequisites. By putting all the resources for the quickstarts and tutorials in a group, you can manage them together.
69-
70-
```azurecli-interactive
71-
az group create --name IoTEdgeResources --location westus
72-
```
73-
74-
1. Create an IoT hub in your new resource group. The following code creates a free **F1** hub in the resource group **IoTEdgeResources**. Replace *{hub_name}* with a unique name for your IoT hub.
69+
The following code creates a free **F1** hub in the resource group **IoTEdgeResources**. Replace *{hub_name}* with a unique name for your IoT hub.
7570

7671
```azurecli-interactive
7772
az iot hub create --resource-group IoTEdgeResources --name {hub_name} --sku F1

articles/iot-edge/quickstart.experimental.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,8 +177,14 @@ Configure the runtime with your IoT Edge device connection string that you copie
177177
workload_uri: "http://<GATEWAY_ADDRESS>:15581"
178178
```
179179
180-
8. Find the **Moby Container Runtime settings** section and verify that the value for **network** is set to `nat`.
180+
8. Find the **Moby Container Runtime settings** section and verify that the value for **network** is uncommented and set to **azure-iot-edge**
181181
182+
```yaml
183+
moby_runtime:
184+
docker_uri: "npipe://./pipe/docker_engine"
185+
network: "azure-iot-edge"
186+
```
187+
182188
9. Save the configuration file.
183189
184190
10. In PowerShell, restart the IoT Edge service.

articles/iot-edge/quickstart.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,6 @@ The module that you deploy in this quickstart is a simulated sensor that generat
3434
3535
If you don't have an active Azure subscription, create a [free account][lnk-account] before you begin.
3636

37-
## Prerequisites
38-
39-
This quickstart turns your Windows computer or virtual machine into an IoT Edge device. If you're running Windows in a virtual machine, enable [nested virtualization][lnk-nested] and allocate at least 2GB memory.
40-
41-
Have the following prerequisites ready on the machine that you're using for an IoT Edge device:
42-
43-
1. Make sure you're using a supported Windows version:
44-
* Windows 10 or newer
45-
* Windows Server 2016 or newer
46-
2. Install [Docker for Windows][lnk-docker] and make sure it's running.
47-
3. Configure Docker to use [Linux containers](https://docs.docker.com/docker-for-windows/#switch-between-windows-and-linux-containers)
48-
4937
[!INCLUDE [cloud-shell-try-it.md](../../includes/cloud-shell-try-it.md)]
5038

5139
You use the Azure CLI to complete many of the steps in this quickstart, and Azure IoT has an extension to enable additional functionality.
@@ -56,25 +44,41 @@ Add the Azure IoT extension to the cloud shell instance.
5644
az extension add --name azure-cli-iot-ext
5745
```
5846

59-
## Create an IoT hub
47+
## Prerequisites
6048

61-
Start the quickstart by creating your IoT Hub in the Azure portal.
62-
![Create IoT Hub][3]
49+
Cloud resources:
6350

64-
The free level of IoT Hub works for this quickstart. If you've used IoT Hub in the past and already have a free hub created, you can use that IoT hub. Each subscription can only have one free IoT hub.
65-
66-
1. In the Azure cloud shell, create a resource group. The following code creates a resource group called **IoTEdgeResources** in the **West US** region. By putting all the resources for the quickstarts and tutorials in a group, you can manage them together.
51+
* A resource group to manage all the resources you use in this quickstart.
6752

6853
```azurecli-interactive
6954
az group create --name IoTEdgeResources --location westus
7055
```
7156

72-
1. Create an IoT hub in your new resource group. The following code creates a free **F1** hub in the resource group **IoTEdgeResources**. Replace *{hub_name}* with a unique name for your IoT hub.
57+
A Windows computer or virtual machine to act as your IoT Edge device:
58+
59+
* Use a supported Windows version:
60+
* Windows 10 or newer
61+
* Windows Server 2016 or newer
62+
* If it's a virtual machine, enable [nested virtualization][lnk-nested] and allocate at least 2GB memory.
63+
* Install [Docker for Windows][lnk-docker] and make sure it's running.
64+
* Configure Docker to use [Linux containers](https://docs.docker.com/docker-for-windows/#switch-between-windows-and-linux-containers)
65+
66+
## Create an IoT hub
67+
68+
Start the quickstart by creating your IoT Hub with Azure CLI.
69+
70+
![Create IoT Hub][3]
71+
72+
The free level of IoT Hub works for this quickstart. If you've used IoT Hub in the past and already have a free hub created, you can use that IoT hub. Each subscription can only have one free IoT hub.
73+
74+
The following code creates a free **F1** hub in the resource group **IoTEdgeResources**. Replace *{hub_name}* with a unique name for your IoT hub.
7375

7476
```azurecli-interactive
7577
az iot hub create --resource-group IoTEdgeResources --name {hub_name} --sku F1
7678
```
7779

80+
If you get an error because there's already one free hub in your subscription, change the SKU to **S1**.
81+
7882
## Register an IoT Edge device
7983

8084
Register an IoT Edge device with your newly created IoT Hub.
@@ -204,7 +208,13 @@ Configure the runtime with your IoT Edge device connection string that you copie
204208
workload_uri: "http://<GATEWAY_ADDRESS>:15581"
205209
```
206210
207-
8. Find the **Moby Container Runtime settings** section and verify that the value for **network** is set to `nat`.
211+
8. Find the **Moby Container Runtime settings** section and verify that the value for **network** is uncommented and set to **azure-iot-edge**
212+
213+
```yaml
214+
moby_runtime:
215+
docker_uri: "npipe://./pipe/docker_engine"
216+
network: "azure-iot-edge"
217+
```
208218
209219
9. Save the configuration file.
210220

articles/iot-edge/tutorial-c-module.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,36 @@ ms.custom: mvc
1616

1717
# Tutorial: Develop a C IoT Edge module and deploy to your simulated device
1818

19-
You can use IoT Edge modules to deploy code that implements your business logic directly to your IoT Edge devices. This tutorial walks you through creating and deploying an IoT Edge module that filters sensor data. You'll use the simulated IoT Edge device that you created in the Deploy Azure IoT Edge on a simulated device in [Windows][lnk-tutorial1-win] or [Linux][lnk-tutorial1-lin] tutorials. In this tutorial, you learn how to:
19+
You can use IoT Edge modules to deploy code that implements your business logic directly to your IoT Edge devices. This tutorial walks you through creating and deploying an IoT Edge module that filters sensor data. In this tutorial, you learn how to:
2020

2121
> [!div class="checklist"]
2222
> * Use Visual Studio Code to create an IoT Edge module in C
23-
> * Use Visual Studio Code and Docker to create a docker image and publish it to your registry
23+
> * Use Visual Studio Code and Docker to create a docker image and publish it to a container registry
2424
> * Deploy the module to your IoT Edge device
2525
> * View generated data
2626
2727

2828
The IoT Edge module that you create in this tutorial filters the temperature data generated by your device. It only sends messages upstream if the temperature is above a specified threshold. This type of analysis at the edge is useful for reducing the amount of data communicated to and stored in the cloud.
2929

30-
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free) before you begin.
30+
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
3131

3232

3333
## Prerequisites
3434

35-
* The Azure IoT Edge device that you created in the quickstart for [Linux](quickstart-linux.md) or [Windows devices](quickstart.md).
36-
* The primary key connection string for the IoT Edge device.
35+
An Azure IoT Edge device:
36+
37+
* You can use your development machine or a virtual machine as an Edge device by following the steps in the quickstart for [Linux](quickstart-linux.md) or [Windows devices](quickstart.md).
38+
39+
Cloud resources:
40+
41+
* A standard-tier [IoT Hub](../iot-hub/iot-hub-create-through-portal.md) in Azure.
42+
43+
Development resources:
44+
3745
* [Visual Studio Code](https://code.visualstudio.com/).
3846
* [C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) for Visual Studio Code.
3947
* [Azure IoT Edge extension](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-edge) for Visual Studio Code.
40-
* [Docker CE](https://docs.docker.com/install/) on your development machine.
48+
* [Docker CE](https://docs.docker.com/install/).
4149

4250

4351
## Create a container registry

articles/iot-edge/tutorial-csharp-module.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,26 @@ You can use Azure IoT Edge modules to deploy code that implements your business
2727

2828
The IoT Edge module that you create in this tutorial filters the temperature data that's generated by your device. It only sends messages upstream if the temperature is above a specified threshold. This type of analysis at the edge is useful for reducing the amount of data that's communicated to and stored in the cloud.
2929

30-
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free) before you begin.
30+
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
3131

3232

3333
## Prerequisites
3434

35-
* The Azure IoT Edge device that you created in the quickstart for [Linux](quickstart-linux.md) or [Windows devices](quickstart.md).
36-
* The primary key connection string for the IoT Edge device.
35+
An Azure IoT Edge device:
36+
37+
* You can use your development machine or a virtual machine as an Edge device by following the steps in the quickstart for [Linux](quickstart-linux.md) or [Windows devices](quickstart.md).
38+
39+
Cloud resources:
40+
41+
* A standard-tier [IoT Hub](../iot-hub/iot-hub-create-through-portal.md) in Azure.
42+
43+
Development resources:
44+
3745
* [Visual Studio Code](https://code.visualstudio.com/).
3846
* [C# for Visual Studio Code (powered by OmniSharp) extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp).
3947
* [Azure IoT Edge extension](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-edge) for Visual Studio Code.
4048
* [.NET Core 2.1 SDK](https://www.microsoft.com/net/download).
41-
* [Docker CE](https://docs.docker.com/install/) on your development machine.
49+
* [Docker CE](https://docs.docker.com/install/)
4250

4351

4452
## Create a container registry

articles/iot-edge/tutorial-deploy-function.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deploy Azure functions with Azure IoT Edge | Microsoft Docs
3-
description: Deploy an Azure function as a module to an edge device.
3+
description: In this tutorial, you deploy an Azure function as a module to an edge device.
44
author: kgremban
55
manager: timlt
66
ms.author: kgremban
@@ -31,14 +31,21 @@ The Azure function that you create in this tutorial filters the temperature data
3131

3232
## Prerequisites
3333

34-
To test the function module that you build in this tutorial, you need an IoT Edge device. You can use the device that you configured in the [Linux](quickstart-linux.md) or [Windows](quickstart.md) quickstart.
34+
An Azure IoT Edge device:
35+
36+
* You can use your development machine or a virtual machine as an Edge device by following the steps in the quickstart for [Linux](quickstart-linux.md) or [Windows devices](quickstart.md).
37+
38+
Cloud resources:
39+
40+
* A standard-tier [IoT Hub](../iot-hub/iot-hub-create-through-portal.md) in Azure.
41+
42+
Development resources:
3543

36-
You must have the following prerequisites on your development machine:
3744
* [Visual Studio Code](https://code.visualstudio.com/).
3845
* [C# for Visual Studio Code (powered by OmniSharp) extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp).
3946
* [Azure IoT Edge extension](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-edge) for Visual Studio Code.
4047
* [The .NET Core 2.1 SDK](https://www.microsoft.com/net/download).
41-
* [Docker CE](https://docs.docker.com/install/) on your development machine.
48+
* [Docker CE](https://docs.docker.com/install/).
4249

4350
## Create a container registry
4451
In this tutorial, you use the Azure IoT Edge extension for VS Code to build a module and create a **container image** from the files. Then you push this image to a **registry** that stores and manages your images. Finally, you deploy your image from your registry to run on your IoT Edge device.

articles/iot-edge/tutorial-deploy-machine-learning.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deploy Azure Machine Learning with Azure IoT Edge | Microsoft Docs
3-
description: Deploy Azure Machine Learning as a module to an edge device
3+
description: In this tutorial, you deploy Azure Machine Learning as a module to an edge device
44
author: kgremban
55
manager: timlt
66
ms.author: kgremban
@@ -11,7 +11,7 @@ services: iot-edge
1111
ms.custom: mvc
1212
---
1313

14-
# Deploy Azure Machine Learning as an IoT Edge module - preview
14+
# Tutorial: Deploy Azure Machine Learning as an IoT Edge module (preview)
1515

1616
You can use IoT Edge modules to deploy code that implements your business logic directly to your IoT Edge devices. This tutorial walks you through deploying an Azure Machine Learning module that predicts when a device fails based on simulated machine temperature data. For more information about Azure ML on IoT Edge, see [Azure Machine Learning documentation](../machine-learning/desktop-workbench/use-azure-iot-edge-ai-toolkit.md).
1717

@@ -28,15 +28,23 @@ In this tutorial, you learn how to:
2828
>[!NOTE]
2929
>Azure Machine Learning modules on Azure IoT Edge are in public preview.
3030
31+
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
32+
33+
3134
## Prerequisites
3235

33-
To test the Machine Learning module that you build in this tutorial, you need an IoT Edge device. You can use the device that you configured in the quickstart for [Linux](quickstart-linux.md) or [Windows devices](quickstart.md).
36+
An Azure IoT Edge device:
37+
38+
* You can use your development machine or a virtual machine as an Edge device by following the steps in the quickstart for [Linux](quickstart-linux.md) or [Windows devices](quickstart.md).
39+
* The Azure Machine Learning module does not support ARM processors.
40+
41+
Cloud resources:
3442

35-
The Azure Machine Learning module does not support ARM processors.
43+
* A standard-tier [IoT Hub](../iot-hub/iot-hub-create-through-portal.md) in Azure.
3644

37-
Have the following prerequisites on your development machine:
45+
Development resources:
3846
* An Azure Machine Learning account. Follow the instructions in [Create Azure Machine Learning accounts and install Azure Machine Learning Workbench](../machine-learning/service/quickstart-installation.md#create-azure-machine-learning-services-accounts). You do not need to install the workbench application for this tutorial.
39-
* Model Management for Azure ML on your machine. To set up your environment and create an account, follow the instructions in [Model management setup](../machine-learning/desktop-workbench/deployment-setup-configuration.md). During deployment setup, it is recommended to choose the local steps instead of cluster, where possible.
47+
* Model Management for Azure ML. To set up your environment and create an account, follow the instructions in [Model management setup](../machine-learning/desktop-workbench/deployment-setup-configuration.md). During deployment setup, it is recommended to choose the local steps instead of cluster, where possible.
4048

4149
### Disable process identification
4250

articles/iot-edge/tutorial-deploy-stream-analytics.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Tutorial - Deploy ASA jobs to Azure IoT Edge devices | Microsoft Docs
3-
description: Deploy Azure Stream Analytics as a module to an Iot Edge device
3+
description: In this tutorial, you deploy Azure Stream Analytics as a module to an Iot Edge device
44
author: kgremban
55
manager: timlt
66
ms.author: kgremban
@@ -11,7 +11,7 @@ services: iot-edge
1111
ms.custom: mvc
1212
---
1313

14-
# Tutorial: Deploy Azure Stream Analytics as an IoT Edge module - preview
14+
# Tutorial: Deploy Azure Stream Analytics as an IoT Edge module (preview)
1515

1616
Many IoT solutions use analytics services to gain insight about data as it arrives in the cloud from the IoT devices. With Azure IoT Edge, you can take [Azure Stream Analytics][azure-stream] logic and move it onto the device itself. By processing telemetry streams at the edge, you can reduce the amount of uploaded data and reduce the time it takes to react to actionable insights.
1717

@@ -31,10 +31,19 @@ In this tutorial, you learn how to:
3131
>[!NOTE]
3232
>Azure Stream Analytics modules for IoT Edge are in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
3333
34+
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
35+
3436
## Prerequisites
3537

36-
* An IoT hub
37-
* The IoT Edge device that you created and configured in the quickstart for [Windows][lnk-quickstart-win] or [Linux][lnk-quickstart-lin].
38+
An Azure IoT Edge device:
39+
40+
* You can use your development machine or a virtual machine as an Edge device by following the steps in the quickstart for [Linux](quickstart-linux.md) or [Windows devices](quickstart.md).
41+
* The Azure Machine Learning module does not support ARM processors.
42+
43+
Cloud resources:
44+
45+
* A standard-tier [IoT Hub](../iot-hub/iot-hub-create-through-portal.md) in Azure.
46+
3847

3948
## Create an Azure Stream Analytics job
4049

0 commit comments

Comments
 (0)