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
Copy file name to clipboardExpand all lines: articles/iot-hub-device-update/create-device-update-account.md
+59-21Lines changed: 59 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Create a device update account in Device Update for Azure IoT Hub | Micro
3
3
description: Create a device update account in Device Update for Azure IoT Hub.
4
4
author: vimeht
5
5
ms.author: vimeht
6
-
ms.date: 06/22/2022
6
+
ms.date: 06/23/2022
7
7
ms.topic: how-to
8
8
ms.service: iot-hub-device-update
9
9
ms.custom: subject-rbac-steps
@@ -19,7 +19,7 @@ To get started with Device Update you'll need to create a Device Update account
19
19
20
20
An IoT hub. It's recommended that you use an S1 (Standard) tier or above.
21
21
22
-
# [CLI](#tab/cli)
22
+
# [Azure CLI](#tab/cli)
23
23
24
24
* An IoT hub. It's recommended that you use an S1 (Standard) tier or above.
25
25
@@ -29,27 +29,27 @@ An IoT hub. It's recommended that you use an S1 (Standard) tier or above.
29
29
30
30
[](https://shell.azure.com)
31
31
32
-
*If you prefer to run CLI reference commands locally, [install the Azure CLI](/cli/azure/install-azure-cli)
32
+
*Or, if you prefer to run CLI reference commands locally, [install the Azure CLI](/cli/azure/install-azure-cli)
33
33
34
34
* Sign in to the Azure CLI by using the [az login](/cli/azure/reference-index#az-login) command.
35
+
35
36
* Run [az version](/cli/azure/reference-index#az-version) to find the version and dependent libraries that are installed. To upgrade to the latest version, run [az upgrade](/cli/azure/reference-index#az-upgrade).
37
+
36
38
* When prompted, install Azure CLI extensions on first use. The commands in this article use the **azure-iot** extension. Run `az extension update --name azure-iot` to make sure you're using the latest version of the extension.
37
39
38
40
---
39
41
40
-
## Create a device update account and instance
42
+
## Create a Device Update account and instance
41
43
42
44
# [Azure portal](#tab/portal)
43
45
44
-
1. Go to the [Azure portal](https://portal.azure.com).
45
-
46
-
2. Select **Create a Resource** and search for "Device Update for IoT Hub"
46
+
1. In the [Azure portal](https://portal.azure.com), select **Create a Resource** and search for "Device Update for IoT Hub"
47
47
48
48
:::image type="content" source="media/create-device-update-account/device-update-marketplace.png" alt-text="Screenshot of Device Update for IoT Hub resource." lightbox="media/create-device-update-account/device-update-marketplace.png":::
49
49
50
-
3. Select **Create** > **Device Update for IoT Hub**
50
+
2. Select **Create** > **Device Update for IoT Hub**
51
51
52
-
4. On the **Basics** tab, provide the following information for your Device Update account:
52
+
3. On the **Basics** tab, provide the following information for your Device Update account:
53
53
54
54
***Subscription**: The Azure subscription to be associated with your Device Update account.
55
55
***Resource group**: An existing or new resource group.
@@ -61,42 +61,44 @@ An IoT hub. It's recommended that you use an S1 (Standard) tier or above.
61
61
62
62
:::image type="content" source="media/create-device-update-account/account-details.png" alt-text="Screenshot of account details." lightbox="media/create-device-update-account/account-details.png":::
63
63
64
-
5. Optionally, you can check the box to assign the Device Update administrator role to yourself. You can also use the steps listed in the [Configure access control roles](#configure-access-control-roles) section to provide a combination of roles to users and applications for the right level of access.
64
+
4. Optionally, you can check the box to assign the Device Update administrator role to yourself. You can also use the steps listed in the [Configure access control roles](#configure-access-control-roles) section to provide a combination of roles to users and applications for the right level of access.
65
+
66
+
You need to have Owner or User Access Administrator permissions in your subscription to manage roles.
65
67
66
-
6. Select **Next: Instance**
68
+
5. Select **Next: Instance**
67
69
68
70
An *instance* of Device Update is associated with a single IoT hub. Select the IoT hub that will be used with Device Update. When you link an IoT hub to a Device Update instance, a new shared access policy is automatically created give Device Update permissions to work with IoT Hub (registry write and service connect). This policy ensures that access is only limited to Device Update.
69
71
70
-
7. On the **Instance** tab, provide the following information for your Device Update instance:
72
+
6. On the **Instance** tab, provide the following information for your Device Update instance:
71
73
72
74
***Name**: A name for your instance.
73
75
***IoT Hub details**: Select an IoT hub to link to this instance.
74
76
75
77
:::image type="content" source="media/create-device-update-account/instance-details.png" alt-text="Screenshot of instance details." lightbox="media/create-device-update-account/instance-details.png":::
76
78
77
-
8. Select **Next: Review + Create**. After validation, select **Create**.
79
+
7. Select **Next: Review + Create**. After validation, select **Create**.
78
80
79
81
:::image type="content" source="media/create-device-update-account/account-review.png" alt-text="Screenshot of account review." lightbox="media/create-device-update-account/account-review.png":::
80
82
81
-
9. You'll see that your deployment is in progress. The deployment status will change to "complete" in a few minutes. When it does, select **Go to resource**
83
+
8. You'll see that your deployment is in progress. The deployment status will change to "complete" in a few minutes. When it does, select **Go to resource**
82
84
83
85
:::image type="content" source="media/create-device-update-account/account-complete.png" alt-text="Screenshot of account deployment complete." lightbox="media/create-device-update-account/account-complete.png":::
84
86
85
-
# [CLI](#tab/cli)
87
+
# [Azure CLI](#tab/cli)
86
88
87
89
Use the [az iot device-update account create](/cli/azure/iot/device-update/account#az-iot-device-update-account-create) command to create a new Device Update account.
88
90
89
91
Replace the following placeholders with your own information:
90
92
91
93
**\<resource_group>*: An existing resource group in your subscription.
92
-
**\<name>*: A name for your Device Update account.
94
+
**\<account_name>*: A name for your Device Update account.
93
95
**\<region>*: The Azure region where your account will be located. For information about which regions support Device Update for IoT Hub, see [Azure Products-by-region page](https://azure.microsoft.com/global-infrastructure/services/?products=iot-hub). If no region is provided, the resource group's location is used.
94
96
95
97
> [!NOTE]
96
98
> Your Device Update account doesn't need to be in the same region as your IoT hubs, but for better performance it is recommended that you keep them geographically close.
Use the [az iot device-update instance create](/cli/azure/iot/device-update/instance#az-iot-device-update-instance-create) command to create a Device Update instance.
@@ -106,13 +108,16 @@ An *instance* of Device Update is associated with a single IoT hub. Select the I
106
108
Replace the following placeholders with your own information:
107
109
108
110
**\<account_name>*: The name of the Device Update account that this instance will be associated with.
109
-
**\<name>*: A name for this instance.
111
+
**\<instance_name>*: A name for this instance.
110
112
**\<iothub_id>*: The resource ID for the IoT hub that will be linked to this instance. You can retrieve your IoT hub resource ID by using the [az iot hub show](/cli/azure/iot/hub#az-iot-hub-show) command and querying for the ID value: `az iot hub show -n <iothub_name> --query id`.
>As part of the instance creation process, you can also configure diagnostics logging. For more information, see [Remotely collect diagnostic logs from devices](device-update-log-collection.md).
120
+
116
121
---
117
122
118
123
## Configure access control roles
@@ -149,7 +154,7 @@ In order for other users to have access to Device Update, they must be granted a
149
154
7. Review the new role assignments and select **Review + assign** again
150
155
8. You're now ready to use Device Update from within your IoT Hub
151
156
152
-
# [CLI](#tab/cli)
157
+
# [Azure CLI](#tab/cli)
153
158
154
159
The following roles are available for assigning access to Device Update:
155
160
@@ -171,9 +176,42 @@ Replace the following placeholders with your own information:
171
176
**\<account_id>*: The resource ID for the Device Update account that the user or group will get access to. You can retrieve the resource ID by using the [az iot device-update account show](/cli/azure/iot/device-update/account#az-iot-device-update-account-show) command and querying for the ID value: `az iot device-update account show -n <account_name> --query id`.
172
177
173
178
```azurecli-interactive
174
-
az role assignment create --role '<role>` --assignee <user_group> --scope <account_id>
179
+
az role assignment create --role '<role>' --assignee <user_group> --scope <account_id>
180
+
```
181
+
182
+
---
183
+
184
+
## View and query accounts or instances
185
+
186
+
You can view, sort, and query all of your Device Update accounts and instances.
187
+
188
+
# [Azure portal](#tab/portal)
189
+
190
+
1. To view all Device Update accounts, use the Azure portal to search for the **Device Update for IoT Hubs** service.
191
+
192
+
* Use the **Grouping** dropdown menu to group account by subscription, resource group, location, and other conditions.
193
+
* Select **Add filter** to filter the list of accounts by resource group, location, tags, and other conditions.
194
+
195
+
1. To view all instances in an account, navigate to that account in the Azure portal. Select **Instances** from the **Instance management** section of the menu
196
+
197
+
* Use the search box to filter instances.
198
+
199
+
# [Azure CLI](#tab/cli)
200
+
201
+
To view all Device Update accounts, use the [az iot device-update account list](/cli/azure/iot/device-update/account#az-iot-device-update-account-list) command.
202
+
203
+
```azurecli-interactive
204
+
az iot device-update account list
205
+
```
206
+
207
+
To view all instances in an account, use the [az iot device-update instance list](/cli/azure/iot/device-update/instance#az-iot-device-update-instance-list) command.
208
+
209
+
```azurecli-interactive
210
+
az iot device-update instance list --account <account_name>
175
211
```
176
212
213
+
Both `list` commands support additional grouping and filter operations. Use the `--query` argument to find accounts or instances based on conditions like tags. For example, `--query "[?tags.env == 'test']"`. Use the `--output` argument to format the results. For example, `--output table`.
Copy file name to clipboardExpand all lines: articles/iot-hub-device-update/device-update-log-collection.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Device Update for Azure IoT Hub log collection | Microsoft Docs
3
3
description: Device Update for IoT Hub enables remote collection of diagnostic logs from connected IoT devices.
4
4
author: lichris
5
5
ms.author: lichris
6
-
ms.date: 06/22/2022
6
+
ms.date: 06/23/2022
7
7
ms.topic: how-to
8
8
ms.service: iot-hub-device-update
9
9
---
@@ -23,7 +23,7 @@ Learn how to initiate a Device Update for IoT Hub log operation and view collect
23
23
> [!NOTE]
24
24
> The remote log collection feature is currently compatible only with devices that implement the Diagnostic Interface and are able to upload files to Azure Blob storage. The reference agent implementation also expects the device to write log files to a user-specified file path on the device.
25
25
26
-
# [CLI](#tab/cli)
26
+
# [Azure CLI](#tab/cli)
27
27
28
28
*[Access to an IoT Hub with Device Update for IoT Hub enabled](create-device-update-account.md).
29
29
@@ -37,7 +37,7 @@ Learn how to initiate a Device Update for IoT Hub log operation and view collect
37
37
38
38
[](https://shell.azure.com)
39
39
40
-
*If you prefer to run CLI reference commands locally, [install the Azure CLI](/cli/azure/install-azure-cli)
40
+
*Or, if you prefer to run CLI reference commands locally, [install the Azure CLI](/cli/azure/install-azure-cli)
41
41
42
42
* Sign in to the Azure CLI by using the [az login](/cli/azure/reference-index#az-login) command.
43
43
* Run [az version](/cli/azure/reference-index#az-version) to find the version and dependent libraries that are installed. To upgrade to the latest version, run [az upgrade](/cli/azure/reference-index#az-upgrade).
@@ -66,7 +66,7 @@ In order to use the remote log collection feature, you must first link an Azure
66
66
67
67
6. Once back on the instance list, select **Refresh** periodically until the instance's provisioning state shows "Succeeded." This process usually takes 2-3 minutes.
68
68
69
-
# [CLI](#tab/cli)
69
+
# [Azure CLI](#tab/cli)
70
70
71
71
Use the [az iot device-update instance create](/cli/azure/iot/device-update/instance#az-iot-device-update-instance-create) command to configure diagnostics for your Device Update instance.
0 commit comments