Skip to content

Commit a82433d

Browse files
Learn Editor: Update troubleshoot-device-update.md
1 parent 46bfc97 commit a82433d

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

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

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ This document lists some common questions and issues reported by Device Update u
1717

1818
### Q: I imported an update successfully, but it's not showing as available for me to deploy to devices that it should be compatible with
1919

20-
Double-check that your import manifest .json file doesn’t have any accidental errors, especially in the [Compatibility object](/azure/iot-hub-device-update/import-schema) values. The compatibility properties in the import manifest must match exactly with the properties reported by your devices, which ensures that the right updates are always only sent to the right devices. For example, if there's a typographical error in the import manifest that causes a compatibility property to have a missing, transposed or extra character compared to what a device reports, the Device Update for IoT Hub service can't match the update to that device. If you've already imported an update, you can quickly check for issues with compatibility properties by clicking the "Details" link for that update and then clicking “Additional details” in the right-hand flyout menu. From there, you can view the import manifest JSON content for that update and identify any potential errors.
20+
Double-check that your import manifest .json file doesn’t have any accidental errors, especially in the [Compatibility object](/azure/iot-hub-device-update/import-schema) values. The compatibility properties in the import manifest must match exactly with the properties reported by your devices, which ensures that the right updates are always only sent to the right devices. For example, there could be a typographical error in the import manifest that causes a compatibility property to have a missing, transposed or extra character compared to what a device reports. If so, the Device Update for IoT Hub service can't match the update to that device. If you already imported an update, you can quickly check for issues with compatibility properties by clicking the "Details" link for that update and then clicking “Additional details” in the right-hand flyout menu. From there, you can view the import manifest JSON content for that update and identify any potential errors.
2121

2222
### Q: I'm having trouble connecting my Device Update instance to my IoT Hub instance
2323

2424
Ensure your IoT Hub message routes are configured correctly, as per the [Device Update resources](./device-update-resources.md) documentation.
2525

2626
### Q: I'm encountering a role-related error (error message in Azure portal or a 403 API error)
2727

28-
You may not have access permissions configured correctly. Ensure you have configured access permissions correctly as per the [Device Update access control](./device-update-control-access.md) documentation.
28+
You may not have access permissions configured correctly. Ensure access permissions are configured correctly as per the [Device Update access control](./device-update-control-access.md) documentation.
2929

3030
### Q: I'm encountering a 500-type error when importing content to the Device Update service
3131

@@ -61,9 +61,9 @@ The device compliance status can take up to 5 minutes to refresh.
6161

6262
### Q: My device's deployment status shows incompatible, what should I do?
6363

64-
The manufacturer and model properties of a targeted device may have changed after connecting the device to IoT Hub, causing the device to now be considered incompatible with the update content of the current deployment.
64+
The manufacturer and model properties of a targeted device might have changed after connecting the device to IoT Hub, causing the device to now be considered incompatible with the update content of the current deployment.
6565

66-
Check the [ADU Core Interface](./device-update-plug-and-play.md) to see what manufacturer and model your device is reporting to the Device Update service, and make sure it matches the manufacturer and model you specified in the [import manifest](./import-concepts.md) of the update content being deployed. You can change these properties for a given device using the [Device Update configuration file](./device-update-configuration-file.md).
66+
Check the [ADU Core Interface](./device-update-plug-and-play.md) to see what manufacturer and model your device is reporting to the Device Update service. Make sure it matches the manufacturer and model you specified in the [import manifest](./import-concepts.md) of the update content that you're deploying. You can change these properties for a given device using the [Device Update configuration file](./device-update-configuration-file.md).
6767

6868
### Q: I see my deployment is in "Active" stage but none of my devices are "In progress" with the update. What should I do?
6969

@@ -79,25 +79,25 @@ If you are using Device Provisioning Service (DPS), then ensure that you tag you
7979

8080
### Q: My deployment completed successfully, but some devices failed to update
8181

82-
This condition may have been caused by a client-side error on the failed devices. See the Device Failures section of this troubleshooting guide.
82+
This condition can be caused by a client-side error on the failed devices. See the Device Failures section of this troubleshooting guide.
8383

8484
### Q: I encountered an error in the UX when trying to initiate a deployment
8585

86-
This condition may have been caused by a service/UX bug, or by an API permissions issue. Follow the instructions in the [Contacting Microsoft Support](#contact) section to file a support request with Microsoft.
86+
This condition can be caused by a service/UX bug, or by an API permissions issue. Follow the instructions in the [Contacting Microsoft Support](#contact) section to file a support request with Microsoft.
8787

8888
### Q: I started a deployment but it isn’t reaching an end state
8989

90-
This condition may have been caused by a service performance issue, a service bug, or a client bug. Retry your deployment after 10 minutes. If you encounter the same issue, please pull your device logs and refer to the Device Failures section of this troubleshooting guide. If the same issue persists, file a support request with Microsoft by following the instructions in the [Contacting Microsoft Support](#contact) section.
90+
This condition can be caused by a service performance issue, a service bug, or a client bug. Retry your deployment after 10 minutes. If you encounter the same issue, please pull your device logs and refer to the Device Failures section of this troubleshooting guide. If the same issue persists, follow the instructions in the [Contacting Microsoft Support](#contact) section to file a support request with Microsoft.
9191

92-
### Q: I migrated from a device level agent to adding the agent as a Module identity on the device, and my update shows as 'in-progress' even though it has been applied to the device
92+
### Q: I migrated from a device-level agent to adding the agent as a Module identity on the device. Now my update shows as 'in-progress' even though it's applied to the device
9393

94-
This condition may have happened because an older agent that was communicating over the Device Twin was not removed. When you provision the Device Update agent as a Module (see [how to](device-update-agent-provisioning.md)) all communications between the device and the Device Update service happen over the Module Twin so remember to tag the Module Twin of the device when creating [groups](device-update-groups.md) and all [communications](device-update-plug-and-play.md) must happen over the module twin.
94+
This condition can happen if an older agent that was communicating over the Device Twin was not removed. When you provision the Device Update agent as a Module (see [how to](device-update-agent-provisioning.md)), all communications between the device and the Device Update service happen over the Module Twin. Remember to tag the Module Twin of the device when creating [groups](device-update-groups.md) and all [communications](device-update-plug-and-play.md) must happen over the module twin.
9595

9696
## <a name="download"></a> Downloading updates onto devices
9797

98-
### Q: How do I resume a download when a device has reconnected after a period of disconnection?
98+
### Q: How do I resume a download when a device reconnects after a period of disconnection?
9999

100-
The download will self-resume when connectivity is restored within a 24-hour period. After 24 hours, the download will need to be reinitiated by the user.
100+
The download will self-resume when connectivity is restored within a 24-hour period. After 24 hours, the user will need to reinitiate the download.
101101

102102
## <a name="mcc"></a> Using Microsoft Connected Cache (MCC)
103103

@@ -107,21 +107,22 @@ Refer to the [IoT Edge documentation](../iot-edge/index.yml) for deploying Edge
107107

108108
### Q: One of my IoT devices is attempting to download an update through MCC, but is failing
109109

110-
There are several issues that could be causing an IoT device to fail in connecting to MCC. In order to diagnose the issue, please collect the DO client and Nginx logs from the failing device (see the [Contacting Microsoft Support](#contact) section for instructions on gathering client logs).
110+
There are several issues that could be causing an IoT device to fail in connecting to MCC. In order to diagnose the issue, collect the DO client and Nginx logs from the failing device (see the [Contacting Microsoft Support](#contact) section for instructions on gathering client logs).
111111

112-
Your device may be failing to pull content from the Internet to pass to its MCC module because the URL it’s using isn’t allowed. To determine if so, you will need to check your IoT Edge environment variables in Azure portal.
112+
Your device may be failing to pull content from the Internet to pass to its MCC module because the URL it’s using isn’t allowed. Confirm this by checking your IoT Edge environment variables in the Azure portal.
113113

114114
## <a name="instance"></a> Troubleshooting a missing instance in the Azure portal
115115

116116
### Q: I don’t see an instance of Device Update for IoT Hub when I select the "gear" icon
117117

118118
There are a few possible causes for this issue. See below for troubleshooting steps.
119119

120-
A Device Update instance needs to be associated with an Azure IoT hub in the same resource group and subscription. If you’ve moved either your Device Update instance or your hub to a different resource group or subscription, you may not see your instance in the Azure portal. You’ll need to do one of the following steps in order to continue using Device Update for IoT Hub:
120+
A Device Update instance needs to be associated with an Azure IoT hub in the same resource group and subscription. If you move either your Device Update instance or your hub to a different resource group or subscription, you may not see your instance in the Azure portal. If so, do one of the following steps in order to continue using Device Update for IoT Hub:
121+
122+
- Return the moved items to their original configuration.
121123

122-
- Return the moved item(s) to their original configuration.
123124
- If you only moved your IoT hub from one resource group to another, modify your Device Update instance with the IoT hub’s new resourceId.
124-
- If you moved item(s) from one subscription to another, make sure the Device Update account and IoT hub are in the same subscription, and then modify your Device Update instance with the IoT hub’s new resourceId.
125+
- If you moved items from one subscription to another, make sure the Device Update account and IoT hub are in the same subscription, and then modify your Device Update instance with the IoT hub’s new resourceId.
125126

126127
At least Read-level permissions are needed for both your IoT hub and your Device Update for IoT Hub account in order to access Device Update functionality via the IoT hub experience in the Azure portal.
127128

@@ -146,22 +147,20 @@ Learn more about [role-based access control](device-update-control-access.md) fo
146147

147148
## <a name="contact"></a> Contacting Microsoft Support
148149

149-
If you run into issues that can't be resolved using the FAQs above, you can file a support request with Microsoft Support through the Azure portal interface. Depending on which category you indicate your issue belongs to, you may be asked to gather and share additional data to help Microsoft Support investigate your issue.
150+
If you run into issues that can't be resolved using the content on this page, you can file a support request with Microsoft Support through the Azure portal interface. Depending on which category you indicate your issue belongs to, you may be asked to gather and share more data to help Microsoft Support investigate your issue.
150151

151-
Please see below for instructions on how to gather each data type.
152+
See the remaining text in this section for instructions on how to gather each data type.
152153

153154
You can use [getDevice](/dotnet/api/azure.iot.deviceupdate.devicemanagementclient.getdevice?view=azure-dotnet-preview&preserve-view=true) to check for additional information in the payload response of the API.
154155

155-
In addition, the following information can be useful for narrowing down the root cause of your issue:
156+
Also include the following information if possible, as it can be useful for narrowing down the root cause of your issue:
156157

157158
- What type of device you are attempting to update (IoT Edge Gateway, other)
158159
- What Device Update client type you are using (Image-based, Package-based, Simulator)
159160
- What OS your device is running
160161
- Details regarding your device's architecture
161162
- Whether you have successfully used Device Update to update a device before
162163

163-
If you have any of the above information available, please include it in your description of the issue.
164-
165164
### Collecting client logs
166165

167166
- On the Raspberry Pi Device there are two sets of logs found here:
@@ -174,13 +173,13 @@ If you have any of the above information available, please include it in your de
174173
/var/cache/do-client-lite/log
175174
```
176175

177-
- For the packaged client the logs are found here:
176+
- For the packaged client, the logs are found here:
178177

179-
```markdown
178+
```markdown
180179
/var/log/adu
181180
```
182181

183-
```markdown
182+
```markdown
184183
/var/cache/do-client-lite/log
185184
```
186185

@@ -194,7 +193,7 @@ If you have any of the above information available, please include it in your de
194193

195194
You may be asked to provide error codes when reporting an issue related to importing an update, a device failure, or deploying an update.
196195

197-
Error codes can be obtained by looking at the [ADUCoreInterface](./device-update-plug-and-play.md) interface. Please refer to the [Device Update error codes](./device-update-error-codes.md) documentation for information on how to parse error codes for self-diagnosis and troubleshooting.
196+
Error codes can be obtained by looking at the [ADUCoreInterface](./device-update-plug-and-play.md) interface. Refer to the [Device Update error codes](./device-update-error-codes.md) documentation for information on how to parse error codes for self-diagnosis and troubleshooting.
198197

199198
### Trace ID
200199

0 commit comments

Comments
 (0)