Merge pull request #94092 from dominicbetts/central-manage-devices-tutorial

v-shils · web-flow · commit 1d778b69ed6c · 2019-10-30T11:15:34.000-07:00
Add device groups tutorial
diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json
@@ -41940,7 +41940,12 @@
     },
     {
       "source_path": "articles/iot-central/howto-use-device-groups-pnp.md",
-      "redirect_url": "/azure/iot-central/core/howto-use-device-groups-pnp/",
+      "redirect_url": "/azure/iot-central/core/tutorial-use-device-groups-pnp/",
+      "redirect_document_id": true
+    },
+    {
+      "source_path": "articles/iot-central/core/howto-use-device-groups-pnp.md",
+      "redirect_url": "/azure/iot-central/core/tutorial-use-device-groups-pnp/",
       "redirect_document_id": true
     },
     {
diff --git a/articles/iot-central-pnp/toc.yml b/articles/iot-central-pnp/toc.yml
@@ -37,6 +37,10 @@
         href: ../iot-central/core/tutorial-define-edge-device-type-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
       - name: Connect an IoT Edge device
         href: ../iot-central/core/tutorial-add-edge-as-leaf-device.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
+    - name: Stay connected
+      items:
+      - name: Create a device group
+        href: ../iot-central/core/tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
     - name: Transform
       items:
         - name: Create a rule
@@ -71,8 +75,10 @@
           href: ../iot-central/core/howto-create-personal-dashboards.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
         - name: Run a job
           href: ../iot-central/core/howto-run-a-job.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
-        - name: Use device groups
-          href: ../iot-central/core/howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
+        - name: Version device template
+          href: ../iot-central/core/howto-version-device-template-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
+    - name: Monitoring and analytics
+      items:
         - name: Analyze your device data
           href: ../iot-central/core/howto-create-analytics-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
     - name: Transform
diff --git a/articles/iot-central/core/howto-create-analytics-pnp.md b/articles/iot-central/core/howto-create-analytics-pnp.md
@@ -34,7 +34,7 @@ Analytics user interface is made of three main components:
 
 You'll need to start by choosing a **device group**, and the telemetry that you want to analyze. Once you're done, select **Analyze** to start visualizing your data.
 
-- **Device group:** A [device group](howto-use-device-groups-pnp.md) is a user-defined group of your devices. For example, all Refrigerators in Oakland, or All version 2.0 wind turbines.
+- **Device group:** A [device group](tutorial-use-device-groups-pnp.md) is a user-defined group of your devices. For example, all Refrigerators in Oakland, or All version 2.0 wind turbines.
 
 - **Telemetry:** Select the telemetry that you want to analyze and explore. You can select multiple telemetries to analyze together. Default aggregation method is set to Average for numerical and Count for string data-type respectively. Supported aggregation methods for Numeric data types are Average, Maximum, Minimum, Count and, Sum.  Supported aggregation methods for string data type are count.
 
diff --git a/articles/iot-central/core/howto-manage-devices-pnp.md b/articles/iot-central/core/howto-manage-devices-pnp.md
@@ -174,6 +174,6 @@ Cloud properties are the device metadata associated with the device, such as cit
 Now that you've learned how to manage devices in your Azure IoT Central application, here is the suggested next step:
 
 > [!div class="nextstepaction"]
-> [How to use device sets](howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json)
+> [How to use device groups](tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json)
 
 <!-- Next how-tos in the sequence -->
diff --git a/articles/iot-central/core/howto-use-device-groups-pnp.md b/articles/iot-central/core/howto-use-device-groups-pnp.md
diff --git a/articles/iot-central/core/index.yml b/articles/iot-central/core/index.yml
@@ -50,7 +50,7 @@ landingContent:
       - linkListType: tutorial
         links:
           - text: Use device groups
-            url: howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
+            url: tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
       - linkListType: how-to-guide
         links:
           - text: Manage your devices
diff --git a/articles/iot-central/core/media/tutorial-use-device-groups-pnp/create-analysis.png b/articles/iot-central/core/media/tutorial-use-device-groups-pnp/create-analysis.png
diff --git a/articles/iot-central/core/media/tutorial-use-device-groups-pnp/customer-name.png b/articles/iot-central/core/media/tutorial-use-device-groups-pnp/customer-name.png
diff --git a/articles/iot-central/core/media/tutorial-use-device-groups-pnp/image1.png b/articles/iot-central/core/media/tutorial-use-device-groups-pnp/image1.png
diff --git a/articles/iot-central/core/media/tutorial-use-device-groups-pnp/image2.png b/articles/iot-central/core/media/tutorial-use-device-groups-pnp/image2.png
diff --git a/articles/iot-central/core/media/tutorial-use-device-groups-pnp/simulated-devices.png b/articles/iot-central/core/media/tutorial-use-device-groups-pnp/simulated-devices.png
diff --git a/articles/iot-central/core/media/tutorial-use-device-groups-pnp/view-analysis.png b/articles/iot-central/core/media/tutorial-use-device-groups-pnp/view-analysis.png
diff --git a/articles/iot-central/core/overview-iot-central-tour-pnp.md b/articles/iot-central/core/overview-iot-central-tour-pnp.md
@@ -133,7 +133,7 @@ To learn more, see the [Monitor your devices](tutorial-monitor-devices.md?toc=/a
 > [!div class="mx-imgBorder"]
 > ![Device groups page](media/overview-iot-central-tour-pnp/device-groups-pnp.png)
 
-Device group are a collection of related devices. A *solution builder* defines a query to identify the devices that are included in a device group. You use device groups to perform bulk operations in your application. To learn more, see the [Use device groups in your Azure IoT Central application](howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json) article.
+Device group are a collection of related devices. A *solution builder* defines a query to identify the devices that are included in a device group. You use device groups to perform bulk operations in your application. To learn more, see the [Use device groups in your Azure IoT Central application](tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json) article.
 
 ### Rules
 > [!div class="mx-imgBorder"]
@@ -146,7 +146,7 @@ The rules page lets you define rules based on devices' telemetry, state, or even
 > [!div class="mx-imgBorder"]
 > ![Analytics page](media/overview-iot-central-tour-pnp/analytics-pnp.png)
 
-The analytics lets you create custom views on top of device data to derive insights from your application. To learn more, see the [Create custom analytics for your Azure IoT Central application](howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json) article.
+The analytics lets you create custom views on top of device data to derive insights from your application. To learn more, see the [Create analytics for your Azure IoT Central application](howto-create-analytics-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json) article.
 
 ### Jobs
 
diff --git a/articles/iot-central/core/tutorial-connect-pnp-device-pnp.md b/articles/iot-central/core/tutorial-connect-pnp-device-pnp.md
@@ -188,4 +188,4 @@ In this tutorial, you learned how to connect an IoT Plug and Play device that wa
 To learn more about DCMs and how to create your own models, continue to the how-to guide:
 
 > [!div class="nextstepaction"]
-> [Set up and manage a device template](./howto-set-up-template-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json)
+> [Create a device group](./tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json)
diff --git a/articles/iot-central/core/tutorial-define-iot-device-type-pnp.md b/articles/iot-central/core/tutorial-define-iot-device-type-pnp.md
@@ -426,4 +426,4 @@ In this tutorial, you learned how to:
 Here is the suggested next step:
 
 > [!div class="nextstepaction"]
-> [Add Edge device](tutorial-add-edge-as-leaf-device.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json)
+> [Connect a device](tutorial-connect-pnp-device-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json)
diff --git a/articles/iot-central/core/tutorial-use-device-groups-pnp.md b/articles/iot-central/core/tutorial-use-device-groups-pnp.md
@@ -0,0 +1,90 @@
+---
+title: Use device groups in your Azure IoT Central application | Microsoft Docs
+description: As an operator, learn how to use device groups to analyze telemetry from  devices in your Azure IoT Central application.
+author: dominicbetts
+ms.author: dobett
+ms.date: 10/29/2019
+ms.topic: conceptual
+ms.service: iot-central
+services: iot-central
+manager: peterpfr
+---
+
+# Tutorial: Use device groups to analyze device telemetry (preview features)
+
+[!INCLUDE [iot-central-pnp-original](../../../includes/iot-central-pnp-original-note.md)]
+
+This article describes how, as an operator, to use device groups to analyze device telemetry in your Azure IoT Central application.
+
+A device group is a list of devices that are grouped together because they match some specified criteria. Device groups help you manage, visualize, and analyze devices at scale by grouping devices into smaller, logical groups. For example, you can create a device group to list all the air conditioner devices in Seattle to enable a technician to find the devices for which they're responsible.
+
+In this tutorial, you learn how to:
+
+> [!div class="checklist"]
+> * Create a device group
+> * USe a device group to analyze device telemetry
+
+## Prerequisites
+
+Before you begin, you should complete the [Create an Azure IoT Central application](./quick-deploy-iot-central-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json) and [Add a simulated device to your IoT Central application](./quick-create-pnp-device-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json) quickstarts to create the **Environment Sensor** device template to work with.
+
+## Create simulated devices
+
+Before you create a device group, add at least five simulated devices from the **Environment Sensor** device template to use in this tutorial:
+
+![Five simulated environmental sensor devices](./media/tutorial-use-device-groups-pnp/simulated-devices.png)
+
+For four of the environmental sensor devices, use the **Environmental Sensor properties** view to set the customer name to **Contoso**:
+
+![Set customer name to Contoso](./media/tutorial-use-device-groups-pnp/customer-name.png)
+
+## Create a device group
+
+To create a device group:
+
+1. Choose **Device Groups** on the left pane.
+
+1. Select **+ New**.
+
+    ![New device group](media/tutorial-use-device-groups-pnp/image1.png)
+
+1. Give your device group a name such as **Contoso devices**. You can also add a description. A device group can only contain devices from a single device template. Choose the **Environmental Sensor** device template to use for this group.
+
+1. Create the query to identify the devices belonging to **Contoso** for the device group by selecting the **Customer Name** property, the **Equals** comparison operator, and **Contoso** as the value. You can add multiple queries and devices that meet **all** the criteria are placed in the device group. The device group you create is accessible to anyone who has access to the application, so anyone can view, modify, or delete the device group.
+
+    ![Device group query](media/tutorial-use-device-groups-pnp/image2.png)
+
+    > [!NOTE]
+    > The device group is a dynamic query. Every time you view the list of devices, there may be different devices in the list. The list depends on which devices currently meet the criteria of the query.
+
+1. Choose **Save**.
+
+> [!NOTE]
+> For Azure IoT Edge devices, select Azure IoT Edge templates to create a device group.
+
+## Analytics
+
+You can use **Analytics** with a device group to analyze the telemetry from the devices in the group. For example, you can plot the average temperature reported by all the Contoso environmental sensors.
+
+To analyze the telemetry for a device group:
+
+1. Choose **Analytics** on the left pane.
+
+1. Select the **Contoso devices** device group you created. Then add both the **Temperature** and **Humidity** telemetry types:
+
+    ![Create analytics](./media/tutorial-use-device-groups-pnp/create-analysis.png)
+
+    Use the gear-wheel icons next to the telemetry types to select an aggregation type. The default is **Average**. Use **Split by** to change how the aggregate data is shown. For example, if you split by device ID you see a plot for each device when you select **Analyze**.
+
+1. Select **Analyze** to view the average telemetry values:
+
+    ![View analysis](./media/tutorial-use-device-groups-pnp/view-analysis.png)
+
+    You can customize the view, change the time period shown, and export the data.
+
+## Next steps
+
+Now that you've learned how to use device groups in your Azure IoT Central application, here is the suggested next step:
+
+> [!div class="nextstepaction"]
+> [How to create telemetry rules](tutorial-create-telemetry-rules-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json)
diff --git a/articles/iot-central/energy/index.yml b/articles/iot-central/energy/index.yml
@@ -54,7 +54,7 @@ landingContent:
       - linkListType: tutorial
         links:
           - text: Use device groups
-            url: ../core/howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
+            url: ../core/tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
       - linkListType: how-to-guide
         links:
           - text: Manage your devices
diff --git a/articles/iot-central/energy/toc.yml b/articles/iot-central/energy/toc.yml
@@ -37,8 +37,6 @@
           href: ../core/howto-manage-devices-pnp.md?toc=/azure/iot-central/energy/toc.json&bc=/azure/iot-central/energy/breadcrumb/toc.json
         - name: Run a job
           href: ../core/howto-run-a-job.md?toc=/azure/iot-central/energy/toc.json&bc=/azure/iot-central/energy/breadcrumb/toc.json
-        - name: Use device groups
-          href: ../core/howto-use-device-groups-pnp.md?toc=/azure/iot-central/energy/toc.json&bc=/azure/iot-central/energy/breadcrumb/toc.json
         - name: Version device template
           href: ../core/howto-version-device-template-pnp.md?toc=/azure/iot-central/energy/toc.json&bc=/azure/iot-central/energy/breadcrumb/toc.json
     - name: Monitoring and analytics
diff --git a/articles/iot-central/government/index.yml b/articles/iot-central/government/index.yml
@@ -54,7 +54,7 @@ landingContent:
       - linkListType: tutorial
         links:
           - text: Use device groups
-            url: ../core/howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
+            url: ../core/tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
       - linkListType: how-to-guide
         links:
           - text: Manage your devices
diff --git a/articles/iot-central/government/toc.yml b/articles/iot-central/government/toc.yml
@@ -41,8 +41,6 @@
           href: ../core/howto-manage-devices-pnp.md?toc=/azure/iot-central/government/toc.json&bc=/azure/iot-central/government/breadcrumb/toc.json
         - name: Run a job
           href: ../core/howto-run-a-job.md?toc=/azure/iot-central/government/toc.json&bc=/azure/iot-central/government/breadcrumb/toc.json
-        - name: Use device groups
-          href: ../core/howto-use-device-groups-pnp.md?toc=/azure/iot-central/government/toc.json&bc=/azure/iot-central/government/breadcrumb/toc.json
         - name: Version device template
           href: ../core/howto-version-device-template-pnp.md?toc=/azure/iot-central/government/toc.json&bc=/azure/iot-central/government/breadcrumb/toc.json
     - name: Monitoring and analytics
diff --git a/articles/iot-central/healthcare/index.yml b/articles/iot-central/healthcare/index.yml
@@ -50,7 +50,7 @@ landingContent:
       - linkListType: tutorial
         links:
           - text: Use device groups
-            url: ../core/howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
+            url: ../core/tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
       - linkListType: how-to-guide
         links:
           - text: Manage your devices
diff --git a/articles/iot-central/healthcare/toc.yml b/articles/iot-central/healthcare/toc.yml
@@ -37,8 +37,6 @@
           href: ../core/howto-manage-devices-pnp.md?toc=/azure/iot-central/healthcare/toc.json&bc=/azure/iot-central/healthcare/breadcrumb/toc.json
         - name: Run a job
           href: ../core/howto-run-a-job.md?toc=/azure/iot-central/healthcare/toc.json&bc=/azure/iot-central/healthcare/breadcrumb/toc.json
-        - name: Use device groups
-          href: ../core/howto-use-device-groups-pnp.md?toc=/azure/iot-central/healthcare/toc.json&bc=/azure/iot-central/healthcare/breadcrumb/toc.json
         - name: Version device template
           href: ../core/howto-version-device-template-pnp.md?toc=/azure/iot-central/healthcare/toc.json&bc=/azure/iot-central/healthcare/breadcrumb/toc.json
     - name: Monitoring and analytics
diff --git a/articles/iot-central/index.yml b/articles/iot-central/index.yml
@@ -53,7 +53,7 @@ conceptualContent:
 
     - title: Stay connected (preview features)
       links: 
-        - url: ./core/howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
+        - url: ./core/tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
           itemType: how-to-guide
           text: Use device groups
         - url: ./core/howto-manage-devices-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
diff --git a/articles/iot-central/retail/index.yml b/articles/iot-central/retail/index.yml
@@ -64,7 +64,7 @@ landingContent:
       - linkListType: tutorial
         links:
           - text: Use device groups
-            url: ../core/howto-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
+            url: ../core/tutorial-use-device-groups-pnp.md?toc=/azure/iot-central-pnp/toc.json&bc=/azure/iot-central-pnp/breadcrumb/toc.json
       - linkListType: how-to-guide
         links:
           - text: Manage your devices
diff --git a/articles/iot-central/retail/toc.yml b/articles/iot-central/retail/toc.yml

Original file line number	Diff line number	Diff line change
`@@ -41940,7 +41940,12 @@`
`41940`	`41940`	`},`
`41941`	`41941`	`{`
`41942`	`41942`	`"source_path": "articles/iot-central/howto-use-device-groups-pnp.md",`
`41943`		`- "redirect_url": "/azure/iot-central/core/howto-use-device-groups-pnp/",`
	`41943`	`+ "redirect_url": "/azure/iot-central/core/tutorial-use-device-groups-pnp/",`
	`41944`	`+ "redirect_document_id": true`
	`41945`	`+ },`
	`41946`	`+ {`
	`41947`	`+ "source_path": "articles/iot-central/core/howto-use-device-groups-pnp.md",`
	`41948`	`+ "redirect_url": "/azure/iot-central/core/tutorial-use-device-groups-pnp/",`
`41944`	`41949`	`"redirect_document_id": true`
`41945`	`41950`	`},`
`41946`	`41951`	`{`