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/configure-access-control-device-update.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ ms.subservice: device-update
11
11
12
12
# Configure access control for Device Update resources
13
13
14
-
For users to access Azure Device Update for IoT Hub, you must grant them access to the Device Update account and instance. You must also grant the Device Update service principal access to the linked IoT hub so it can manage updates and gather information. This article describes how to grant the necessary access by using the Azure portal or the Azure CLI.
14
+
For users to access Azure Device Update for IoT Hub, you must grant them access to the Device Update account and instance. You must also grant the Device Update service principal access to the linked IoT hub so it can manage updates and gather information. This article describes how to grant the necessary access by using Azure role-based access control (RBAC) in the Azure portal or Azure CLI.
15
15
16
16
## Prerequisites
17
17
@@ -21,7 +21,7 @@ For users to access Azure Device Update for IoT Hub, you must grant them access
21
21
22
22
## Configure access control for Device Update account
23
23
24
-
The following roles are available through Azure role-based access control (RBAC) for assigning access to Device Update:
24
+
The following roles are available for assigning access to Device Update:
25
25
26
26
- Device Update Administrator
27
27
- Device Update Reader
@@ -48,7 +48,7 @@ For more information, see [Azure role-based access control (RBAC) and Device Upd
48
48
49
49
1. Select **Review + assign**.
50
50
1. Review the new role assignments and select **Review + assign** again.
51
-
1. Azure role-based access control (RBAC) adds the role assignments, and the selected members can now use Device Update from within your IoT Hub.
51
+
1. Azure RBAC adds the role assignments, and the selected members can now use Device Update from within your IoT Hub.
52
52
53
53
# [Azure CLI](#tab/cli)
54
54
@@ -90,7 +90,7 @@ Device Update communicates with IoT Hub to manage deployments and updates and to
90
90
91
91
:::image type="content" source="media/create-device-update-account/assign-role-to-du-service-principal.png" alt-text="Screenshot of access Control member selection for IoT Hub." lightbox="media/create-device-update-account/assign-role-to-du-service-principal.png":::
92
92
93
-
6. Select **Review + Assign** and then select **Review + Assign** again.
93
+
6. Select **Review + assign** and then select **Review + assign** again.
94
94
95
95
To validate that you set permissions correctly:
96
96
@@ -114,4 +114,4 @@ az role assignment create --role "IoT Hub Data Contributor" --assignee https://a
114
114
## Related content
115
115
116
116
-[Azure role-based access control (RBAC) and Device Update](device-update-control-access.md)
117
-
-[az role assignment](/cli/azure/role/assignment)
117
+
-[Command reference for az role assignment](/cli/azure/role/assignment)
Copy file name to clipboardExpand all lines: articles/iot-hub-device-update/create-update.md
+14-15Lines changed: 14 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Prepare an update to import into Azure Device Update for IoT Hub | Microsoft Docs
3
-
description: Learn how to prepare a new update to import into Azure Device Update for IoT Hub.
3
+
description: Learn how to prepare an update for import into Azure Device Update for IoT Hub by creating an import manifest to describe the update.
4
4
author: andrewbrownmsft
5
5
ms.author: andbrown
6
6
ms.date: 12/20/2024
@@ -12,7 +12,7 @@ ms.subservice: device-update
12
12
13
13
# Prepare an update to import into Device Update
14
14
15
-
This article describes how to get a new update and prepare it for importing into Azure Device Update for IoT Hub.
15
+
This article describes how to get a new update and prepare it for importing into Azure Device Update for IoT Hub by creating an import manifest.
16
16
17
17
## Prerequisites
18
18
@@ -31,30 +31,26 @@ This article describes how to get a new update and prepare it for importing into
31
31
>[!TIP]
32
32
>The Azure CLI commands in this article use the backslash \\ character for line continuation so that the command arguments are easier to read. This syntax works in Bash environments. If you run these commands in PowerShell, replace each backslash with a backtick \`, or remove them entirely.
33
33
34
-
## Obtain an update for your device
34
+
<aname="obtain-an-update-for-your-device"></a>
35
+
## Get the update files for your device
35
36
36
-
Get one or more update files to deploy to your device.
37
+
Get the update file or files to deploy to your device using Device Update. If you purchased devices from an original equipment manufacturer (OEM) or solution integrator, that organization probably provides updates without you having to create update files. Contact the OEM or solution integrator to find out how they make updates available. If your organization creates software for your devices, it also creates the updates for that software.
37
38
38
-
If you purchased devices from an Original Equipment Manufacturer (OEM) or solution integrator, that organization probably provides updates without you having to create update files. Contact the OEM or solution integrator to find out how they make updates available. If your organization creates software for the devices you use, the same organization creates the updates for that software.
39
-
40
-
When you create an update to deploy using Device Update, use either the [image-based or package-based approach](understand-device-update.md#support-for-a-wide-range-of-update-artifacts), depending on your scenario.
39
+
To create the update, choose either the [image-based or package-based update type](understand-device-update.md#support-for-a-wide-range-of-update-artifacts), depending on your scenario.
41
40
42
41
> [!TIP]
43
42
> You can try the [image-based](device-update-raspberry-pi.md), [package-based](device-update-ubuntu-agent.md), or [proxy update](device-update-howto-proxy-updates.md) tutorials, or just view sample import manifest files from those tutorials for reference.
44
43
45
44
## Create a basic Device Update import manifest
46
45
47
-
Once you have your update files and are familiar with basic [Device Update import concepts](import-concepts.md), create an import manifest to describe the update. While you can author a JSON import manifest manually using a text editor, the Azure CLI [az iot du init v5](/cli/azure/iot/du/update/init#az-iot-du-update-init-v5) command simplifies the process, as shown in the following examples. For more information, see [Device Update import schema and API information](import-schema.md).
46
+
Once you have your update files and are familiar with basic [Device Update import concepts](import-concepts.md), create an import manifest to describe the update. While you can author a JSON import manifest manually using a text editor, the Azure CLI [az iot du init v5](/cli/azure/iot/du/update/init#az-iot-du-update-init-v5) command simplifies the process. For more information about the import manifest schema, see [Device Update import schema and API information](import-schema.md).
48
47
49
48
The `az iot du init v5` command takes the following arguments. All are required except `--file`, which is derived from `--step` if not specified. There is positional sensitivity between `--step` and `--file`.
50
49
51
50
- The `--update-provider`, `--update-name`, and `--update-version` parameters define the `updateId` object that's a unique identifier for each update.
52
51
- The `--compat` compatibility object is a set of name-value pairs that describe the properties of a device that this update is compatible with. You can use a specific set of compatibility properties with only one provider and name combination.
53
-
-`--step` specifies the update `handler` on the device, such as `microsoft/script:1`, `microsoft/swupdate:1`, or `microsoft/apt:1`, and its associated `properties` for this update. You can use `--step` more than one time.
54
-
-`--file` specifies the `path` to your update files. You can use `--file` one or more times.
55
-
56
-
> [!TIP]
57
-
> For handler properties, you might need to escape certain characters in your JSON. For example, use `'\'` to escape double quotes if you run the Azure CLI in PowerShell.
52
+
- The `--step` parameter specifies the update `handler` on the device, such as `microsoft/script:1`, `microsoft/swupdate:1`, or `microsoft/apt:1`, and its associated `properties` for this update. You can use `--step` more than once.
53
+
- The `--file` parameter specifies the `path` to your update files. You can use `--file` one or more times.
58
54
59
55
```azurecli
60
56
az iot du update init v5 \
@@ -66,7 +62,7 @@ az iot du update init v5 \
66
62
--file path=<paths and full file names of your update files>
67
63
```
68
64
69
-
For example:
65
+
The following `az iot du update init v5` command shows example values:
70
66
71
67
```azurecli
72
68
az iot du update init v5 \
@@ -78,6 +74,9 @@ az iot du update init v5 \
78
74
--file path=/my/apt/manifest/file
79
75
```
80
76
77
+
> [!TIP]
78
+
> For handler properties, you might need to escape certain characters in your JSON. For example, use `'\'` to escape double quotes if you run the Azure CLI in PowerShell.
79
+
81
80
The `az iot du init v5` command supports advanced scenarios, including the [related files feature](related-files.md) that allows you to define the relationship between different update files. For more examples and a complete list of optional parameters, see the [az iot du init v5](/cli/azure/iot/du/update/init#az-iot-du-update-init-v5) command reference.
82
81
83
82
Once you create your import manifest and save it as a JSON file, you can [import the update](import-update.md). If you plan to use the Azure portal for importing, be sure to name your import manifest with the format *\<manifestname\>.importmanifest.json*.
@@ -86,7 +85,7 @@ Once you create your import manifest and save it as a JSON file, you can [import
86
85
87
86
If your update is more complex, such as a [proxy update](device-update-proxy-updates.md), you might need to create multiple import manifests. For complex updates, you can use the `az iot du update init v5` Azure CLI command to create a *parent* import manifest and some number of *child* import manifests.
88
87
89
-
Run the following Azure CLI commands after replacing the placeholder values. For details on the values you can use, see [Import schema and API information](import-schema.md). The following example shows three updates to deploy to the device, a parent update and two child updates.
88
+
Replace the placeholder values in the following Azure CLI commands. For details on the values you can use, see [Import schema and API information](import-schema.md). The following example shows three updates to deploy to the device, a parent update and two child updates.
0 commit comments