Skip to content

Commit 0d82f21

Browse files
Merge pull request #216775 from kgremban/nov1-cliref
Update Device Update CLI reference links
2 parents 54cb1dc + 9907b69 commit 0d82f21

10 files changed

+25
-25
lines changed

articles/iot-hub-device-update/configure-access-control-device-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Replace the following placeholders with your own information:
6363

6464
* *\<role>*: The Device Update role that you're assigning.
6565
* *\<user_group>*: The user or group that you want to assign the role to.
66-
* *\<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`.
66+
* *\<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 du account show](/cli/azure/iot/du/account#az-iot-du-account-show) command and querying for the ID value: `az iot du account show -n <account_name> --query id`.
6767

6868
```azurecli-interactive
6969
az role assignment create --role '<role>' --assignee <user_group> --scope <account_id>

articles/iot-hub-device-update/configure-private-endpoints.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ You can use either the Azure portal or the Azure CLI to create private endpoints
103103
1. Fill all the required fields on the **Resource** tab
104104

105105
* **Connection method**: Select **Connect to an Azure resource by resource ID or alias**.
106-
* **Resource ID or alias**: Enter the Resource ID of the Device Update account. You can retrieve the resource ID of a Device Update account from the Azure portal by selecting **JSON View** on the **Overview** page. Or, you can retrieve it by using the [az iot du account show](/cli/azure/iot/device-update/account#az-iot-device-update-account-show) command and querying for the ID value: `az iot du account show -n <account_name> --query id`.
106+
* **Resource ID or alias**: Enter the Resource ID of the Device Update account. You can retrieve the resource ID of a Device Update account from the Azure portal by selecting **JSON View** on the **Overview** page. Or, you can retrieve it by using the [az iot du account show](/cli/azure/iot/du/account#az-iot-du-account-show) command and querying for the ID value: `az iot du account show -n <account_name> --query id`.
107107
* **Target sub-resource**: Value must be **DeviceUpdate**
108108

109109
:::image type="content" source="./media/configure-private-endpoints/private-endpoint-manual-create.png" alt-text="Screenshot showing the Resource page of the Create a private endpoint tab in Private Link Center.":::
@@ -130,7 +130,7 @@ Replace the following placeholders with your own information:
130130
* **PRIVATE_LINK_CONNECTION_NAME**: Name of the private link service connection.
131131
* **VIRTUAL_NETWORK_NAME**: Name of an existing virtual network associated with the subnet.
132132
* **SUBNET_NAME**: Name or ID of an existing subnet. If you use a subnet name, then you also need to include the virtual network name. If you use a subnet ID, you can omit the `--vnet-name` parameter.
133-
* **DEVICE_UPDATE_RESOURCE_ID**: You can retrieve the resource ID of a Device Update account from the Azure portal by selecting **JSON View** on the **Overview** page. Or, you can retrieve it by using the [az iot du account show](/cli/azure/iot/device-update/account#az-iot-device-update-account-show) command and querying for the ID value: `az iot du account show -n <account_name> --query id`.
133+
* **DEVICE_UPDATE_RESOURCE_ID**: You can retrieve the resource ID of a Device Update account from the Azure portal by selecting **JSON View** on the **Overview** page. Or, you can retrieve it by using the [az iot du account show](/cli/azure/iot/du/account#az-iot-du-account-show) command and querying for the ID value: `az iot du account show -n <account_name> --query id`.
134134
* **LOCATION**: Name of the Azure region. Your private endpoint must be in the same region as your virtual network, but can in a different region from the Device Update account.
135135

136136
```azurecli-interactive
@@ -192,7 +192,7 @@ There are four provisioning states:
192192

193193
# [Azure CLI](#tab/cli)
194194

195-
Use the [az iot du account private-endpoint-connection set](/cli/azure/iot/device-update/account/private-endpoint-connection#az-iot-device-update-account-private-endpoint-connection-set) command to manage private endpoint connection.
195+
Use the [az iot du account private-endpoint-connection set](/cli/azure/iot/du/account/private-endpoint-connection#az-iot-du-account-private-endpoint-connection-set) command to manage private endpoint connection.
196196

197197
Replace the following placeholders with your own information:
198198

articles/iot-hub-device-update/create-device-update-account.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ An IoT hub. It's required that you use an S1 (Standard) tier or above.
8080

8181
# [Azure CLI](#tab/cli)
8282

83-
Use the [az iot du account create](/cli/azure/iot/device-update/account#az-iot-device-update-account-create) command to create a new Device Update account.
83+
Use the [az iot du account create](/cli/azure/iot/du/account#az-iot-du-account-create) command to create a new Device Update account.
8484

8585
Replace the following placeholders with your own information:
8686

@@ -95,7 +95,7 @@ Replace the following placeholders with your own information:
9595
az iot du account create --resource-group <resource_group> --account <account_name> --location <region>
9696
```
9797

98-
Use the [az iot du instance create](/cli/azure/iot/device-update/instance#az-iot-device-update-instance-create) command to create a Device Update instance.
98+
Use the [az iot du instance create](/cli/azure/iot/du/instance#az-iot-du-instance-create) command to create a Device Update instance.
9999

100100
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.
101101

articles/iot-hub-device-update/create-update-group.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Groups are automatically created based on the tags assigned as well as the compa
148148

149149
# [Azure CLI](#tab/cli)
150150

151-
Use [az iot du device group list](/cli/azure/iot/device-update/device/group#az-iot-du-device-group-list) to view all device groups in a Device Update instance.
151+
Use [az iot du device group list](/cli/azure/iot/du/device/group#az-iot-du-device-group-list) to view all device groups in a Device Update instance.
152152

153153
```azurecli
154154
az iot du device group list \
@@ -176,7 +176,7 @@ You can use the `--order-by` argument to order the groups returned based on aspe
176176

177177
# [Azure CLI](#tab/cli)
178178

179-
Use [az iot du device group show](/cli/azure/iot/device-update/device/group#az-iot-du-device-group-show) to view details of a specific device group.
179+
Use [az iot du device group show](/cli/azure/iot/du/device/group#az-iot-du-device-group-show) to view details of a specific device group.
180180

181181
The optional `--best-updates` flag returns a list of the best available updates for the device group, including a count of how many devices need each update.
182182

articles/iot-hub-device-update/create-update.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Once you have your update files, create an import manifest to describe the updat
4747
> [!TIP]
4848
> 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 if you haven't already done so. You can also just view sample import manifest files from those tutorials for reference.
4949
50-
The [az iot du init v5](/cli/azure/iot/device-update/update/init#az-iot-device-update-update-init-v5) command takes the following arguments:
50+
The [az iot du init v5](/cli/azure/iot/du/update/init#az-iot-du-update-init-v5) command takes the following arguments:
5151

5252
* `--update-provider`, `--update-name`, and `--update-version`: These three parameters define the **updateId** object that is a unique identifier for each update.
5353
* `--compat`: The **compatibility** object is a set of name-value pairs that describe the properties of a device that this update is compatible with.
@@ -81,7 +81,7 @@ az iot du update init v5 \
8181

8282
For handler properties, you may need to escape certain characters in your JSON. For example, use `'\'` to escape double-quotes if you're running the Azure CLI in PowerShell.
8383

84-
The `init` 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 [az iot du init v5](/cli/azure/iot/device-update/update/init#az-iot-device-update-update-init-v5).
84+
The `init` 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 [az iot du init v5](/cli/azure/iot/du/update/init#az-iot-du-update-init-v5).
8585

8686
Once you've created your import manifest and saved it as a JSON file, if you're ready to [import your update](import-update.md).
8787

articles/iot-hub-device-update/deploy-update.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ An Azure CLI environment:
9292

9393
# [Azure CLI](#tab/cli)
9494

95-
Use [az iot du device deployment create](/cli/azure/iot/device-update/device/deployment#az-iot-du-device-deployment-create) to create a deployment for a device group.
95+
Use [az iot du device deployment create](/cli/azure/iot/du/device/deployment#az-iot-du-device-deployment-create) to create a deployment for a device group.
9696

9797
The `device deployment create` command takes the following arguments:
9898

@@ -113,7 +113,7 @@ az iot du device deployment create \
113113
--update-version <update version>
114114
```
115115

116-
Optional arguments allow you to configure the deployment. For the full list, see [Optional parameters](/cli/azure/iot/device-update/device/deployment#az-iot-du-device-deployment-create-optional-parameters)
116+
Optional arguments allow you to configure the deployment. For the full list, see [Optional parameters](/cli/azure/iot/du/device/deployment#az-iot-du-device-deployment-create-optional-parameters)
117117

118118
If you want to create an automatic rollback policy, add the following parameters:
119119

@@ -171,7 +171,7 @@ az iot du device deployment create \
171171

172172
# [Azure CLI](#tab/cli)
173173

174-
Use [az iot du device deployment list](/cli/azure/iot/device-update/device/deployment#az-iot-du-device-deployment-list) to view all deployment for a device group.
174+
Use [az iot du device deployment list](/cli/azure/iot/du/device/deployment#az-iot-du-device-deployment-list) to view all deployment for a device group.
175175

176176
```azurecli
177177
az iot du device deployment list \
@@ -180,7 +180,7 @@ az iot du device deployment list \
180180
--group-id <device group id>
181181
```
182182

183-
Use [az iot du device deployment show](/cli/azure/iot/device-update/device/deployment#az-iot-du-device-deployment-show) to view the details of a particular deployment.
183+
Use [az iot du device deployment show](/cli/azure/iot/du/device/deployment#az-iot-du-device-deployment-show) to view the details of a particular deployment.
184184

185185
```azurecli
186186
az iot du device deployment show \
@@ -217,7 +217,7 @@ If your deployment fails for some reason, you can retry the deployment for faile
217217

218218
# [Azure CLI](#tab/cli)
219219

220-
Use [az iot du device deployment retry](/cli/azure/iot/device-update/device/deployment#az-iot-du-device-deployment-retry) to retry a deployment for a target subgroup of devices.
220+
Use [az iot du device deployment retry](/cli/azure/iot/du/device/deployment#az-iot-du-device-deployment-retry) to retry a deployment for a target subgroup of devices.
221221

222222
This command takes the `--class-id` argument, which is generated from the model ID and compatibility properties reported by the device update agent.
223223

articles/iot-hub-device-update/device-update-agent-check.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The results of agent check can be found in the diagnostics tab of Device Update.
6969

7070
# [Azure CLI](#tab/cli)
7171

72-
Use [az iot du device health list](/cli/azure/iot/device-update/device/health#az-iot-du-device-health-list) to view the health of your devices.
72+
Use [az iot du device health list](/cli/azure/iot/du/device/health#az-iot-du-device-health-list) to view the health of your devices.
7373

7474
The `device health list` command takes the following arguments:
7575

@@ -101,7 +101,7 @@ Only one device sync operation may be active at a time for each Device Update in
101101

102102
# [Azure CLI](#tab/cli)
103103

104-
Use [az iot du device import](/cli/azure/iot/device-update/device#az-iot-du-device-import) to import devices and modules to the Device Update instance from a linked IoT hub.
104+
Use [az iot du device import](/cli/azure/iot/du/device#az-iot-du-device-import) to import devices and modules to the Device Update instance from a linked IoT hub.
105105

106106
```azurecli
107107
az iot du device import --account <Device Update account name> --instance <Device Update instance name>

articles/iot-hub-device-update/device-update-log-collection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ In order to use the remote log collection feature, you must first link an Azure
6767

6868
# [Azure CLI](#tab/cli)
6969

70-
Use the [az iot du instance create](/cli/azure/iot/device-update/instance#az-iot-du-instance-create) command to configure diagnostics for your Device Update instance.
70+
Use the [az iot du instance create](/cli/azure/iot/du/instance#az-iot-du-instance-create) command to configure diagnostics for your Device Update instance.
7171

7272
>[!TIP]
7373
>You can use the `az iot du instance create` command on an existing Device Update instances and it will configure the instance with the updated parameters.
@@ -124,7 +124,7 @@ Log operations are a service-driven action that you can instruct your IoT device
124124

125125
# [Azure CLI](#tab/cli)
126126

127-
Use the [az iot du device log collect](/cli/azure/iot/device-update/device/log#az-iot-du-device-log-collect) command to configure a diagnostics log collection operation.
127+
Use the [az iot du device log collect](/cli/azure/iot/du/device/log#az-iot-du-device-log-collect) command to configure a diagnostics log collection operation.
128128

129129
The `device log collect` command takes the following arguments:
130130

@@ -144,7 +144,7 @@ az iot du device log collect \
144144
--agent-id deviceId=<device name> moduleId=<module name>
145145
```
146146

147-
Use [az iot du device log show](/cli/azure/iot/device-update/device/log#az-iot-du-device-log-show) to view the details of a specific diagnostic log collection operation.
147+
Use [az iot du device log show](/cli/azure/iot/du/device/log#az-iot-du-device-log-show) to view the details of a specific diagnostic log collection operation.
148148

149149
```azurecli
150150
az iot du device log show \

articles/iot-hub-device-update/import-update.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ To import an update, you first upload the update files and import manifest into
106106

107107
# [Azure CLI](#tab/cli)
108108

109-
The [az iot du update stage](/cli/azure/iot/device-update/update#az-iot-du-update-stage) command handles the prerequisite steps of importing an update, including uploading the update files into a target storage container. An optional flag also lets this command automatically import the files after they're prepared. Otherwise, the [az iot du update import](/cli/azure/iot/device-update/update#az-iot-du-update-import) command completes the process.
109+
The [az iot du update stage](/cli/azure/iot/du/update#az-iot-du-update-stage) command handles the prerequisite steps of importing an update, including uploading the update files into a target storage container. An optional flag also lets this command automatically import the files after they're prepared. Otherwise, the [az iot du update import](/cli/azure/iot/du/update#az-iot-du-update-import) command completes the process.
110110

111111
The `stage` command takes the following arguments:
112112

@@ -154,9 +154,9 @@ az iot du update stage \
154154
--overwrite --then-import
155155
```
156156

157-
If you don't use the `--then-import` flag, the output of the `stage` command includes a prompt to run [az iot du update import](/cli/azure/iot/device-update/update#az-iot-du-update-import), including pre-populated arguments.
157+
If you don't use the `--then-import` flag, the output of the `stage` command includes a prompt to run [az iot du update import](/cli/azure/iot/du/update#az-iot-du-update-import), including pre-populated arguments.
158158

159-
Use [az iot du update list](/cli/azure/iot/device-update/update#az-iot-du-update-list) to verify that your update or updates were successfully imported.
159+
Use [az iot du update list](/cli/azure/iot/du/update#az-iot-du-update-list) to verify that your update or updates were successfully imported.
160160

161161
```azurecli
162162
az iot du update list \

articles/iot-hub-device-update/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ items:
8282
items:
8383
- name: Create a Device Update account
8484
href: create-device-update-account.md
85-
displayName: Azure CLI, az iot, az iot device-update
85+
displayName: Azure CLI, az iot, az iot du
8686
- name: Configure access control roles for Device Update resources
8787
href: configure-access-control-device-update.md
88-
displayName: Azure CLI, az iot, az iot device-update
88+
displayName: Azure CLI, az iot, az iot du
8989
- name: Provisioning device update agent
9090
href: device-update-agent-provisioning.md
9191
- name: Create an update

0 commit comments

Comments
 (0)