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/troubleshoot-device-update.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,33 +11,33 @@ ms.subservice: device-update
11
11
12
12
# Device Update for IoT Hub Troubleshooting Guide
13
13
14
-
This document lists some common questions and issues Device Update users have reported. If you encounter an issue that does not appear in this troubleshooting guide, refer to the [Contacting Microsoft Support](#contact) section to document your situation.
14
+
This document lists some common questions and issues reported by Device Update users. If you encounter an issue that does not appear in this troubleshooting guide, refer to the [Contacting Microsoft Support](#contact) section to document your situation.
15
15
16
16
## <aname="import"></a>Importing updates
17
17
18
-
### Q: I’ve imported an update successfully, but it's not showing as available for me to deploy to devices which it should be compatible with
18
+
### 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
19
19
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. This is to ensure 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’s reported by a device, the Device Update for IoT Hub service won’t be able to 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, 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 whata 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.
21
21
22
22
### Q: I'm having trouble connecting my Device Update instance to my IoT Hub instance
23
23
24
-
Please ensure your IoT Hub message routes are configured correctly, as per the [Device Update resources](./device-update-resources.md) documentation.
24
+
Ensure your IoT Hub message routes are configured correctly, as per the [Device Update resources](./device-update-resources.md) documentation.
25
25
26
26
### Q: I'm encountering a role-related error (error message in Azure portal or a 403 API error)
27
27
28
-
You may not have access permissions configured correctly. Please 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 you have configured access permissions correctly as per the [Device Update access control](./device-update-control-access.md) documentation.
29
29
30
30
### Q: I'm encountering a 500-type error when importing content to the Device Update service
31
31
32
-
An error code in the 500 range may indicate an issue with the Device Update service. Please wait 5 minutes, then try again. If the same error persists, please follow the instructions in the [Contacting Microsoft Support](#contact) section to file a support request with Microsoft.
32
+
An error code in the 500 range may indicate an issue with the Device Update service. Wait 5 minutes, then try again. If the same error persists, follow the instructions in the [Contacting Microsoft Support](#contact) section to file a support request with Microsoft.
33
33
34
34
### Q: I want to keep the same compatibility properties (target my update to the same device type), but change the Provider or Name in the import manifest. But I get an error "Failed: error importing update due to exceeded limit" when I do so
35
35
36
-
The same exact set of compatibility properties cannot be used with more than one Update Provider and Name combination. This allows the Device Update service to determine with certainty which updates should be available to deploy to a given device. If you need to update multiple components or partitions on a single device, the [proxy updates](./device-update-proxy-updates.md) feature provides that capability.
36
+
The same exact set of compatibility properties cannot be used with more than one Update Provider and Name combination. This policy allows the Device Update service to determine with certainty which updates should be available to deploy to a given device. If you need to update multiple components or partitions on a single device, the [proxy updates](./device-update-proxy-updates.md) feature provides that capability.
37
37
38
38
### Q: I'm encountering an error message when importing content and would like to understand more about it
39
39
40
-
Please refer to the [Device Update Error Codes](./device-update-error-codes.md#device-update-content-service) documentation for more detailed information on import-related error messages.
40
+
Refer to the [Device Update Error Codes](./device-update-error-codes.md#device-update-content-service) documentation for more detailed information on import-related error messages.
41
41
42
42
## <aname="device-failure"></a>Device failures
43
43
@@ -47,21 +47,21 @@ You can verify that your device is connected to Device Update by checking if it
47
47
48
48
### Q: One or more of my devices is failing to update
49
49
50
-
There are many possible root causes for a device update failure. Please validate that the device is: 1) connected to your IoT Hub instance, 2) connected to your Device Update instance, and 3) the Delivery Optimization (DO) service is running. If all three are true for your device, please follow the instructions in the [Contacting Microsoft Support](#contact) section to file a support request with Microsoft.
50
+
There are many possible root causes for a device update failure. Validate that the device is: 1) connected to your IoT Hub instance, 2) connected to your Device Update instance, and 3) the Delivery Optimization (DO) service is running. If all three are true for your device, follow the instructions in the [Contacting Microsoft Support](#contact) section to file a support request with Microsoft.
51
51
52
52
### Q: My Device Update agent is failing to start up
53
53
54
-
One of the most common reasons for a failure in Device Update agent start-up is a malformed configuration file (du-config.json). Please refer to the [configuration file documentation](./device-update-configuration-file.md) and ensure your agent is configured correctly. Note that all values in the configuration file must use double-quotes.
54
+
One of the most common reasons for a failure in Device Update agent start-up is a malformed configuration file (du-config.json). Refer to the [configuration file documentation](./device-update-configuration-file.md) and ensure your agent is configured correctly. All values in the configuration file must use double-quotes.
55
55
56
56
## <aname="deploy"></a> Deploying an update
57
57
58
-
### Q: I've deployed an update to my device(s), but the compliance status says it isn't on the latest update. What should I do?
58
+
### Q: I deployed an update to my device, but the compliance status says it isn't on the latest update. What should I do?
59
59
60
-
The device compliance status can take up to 5 minutes to refresh. Please wait, then check again.
60
+
The device compliance status can take up to 5 minutes to refresh.
61
61
62
62
### Q: My device's deployment status shows incompatible, what should I do?
63
63
64
-
The manufacturer and model properties of a targeted device may have been 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 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.
65
65
66
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).
67
67
@@ -71,27 +71,27 @@ Ensure that your deployment start date is not set in the future. When you create
71
71
72
72
### Q: I'm trying to group my devices, but I don't see the tag in the drop-down when creating a group
73
73
74
-
Ensure that you have correctly configured the message routes in your IoT Hub as per the [Device Update resources](./device-update-resources.md) documentation. You will have to tag your device again after configuring the route.
74
+
Ensure that the message routes in your IoT Hub are correctly configured as per the [Device Update resources](./device-update-resources.md) documentation. You will have to tag your device again after configuring the route.
75
75
76
76
Another root cause could be that you applied the tag before connecting your device to Device Update for IoT Hub. Ensure that your device is already connected to Device Update. You can verify that your device is connected to Device Update for IoT Hub by checking if it shows up under “Ungrouped” devices in the compliance view. Temporarily add a tag of a different value, and then add your intended tag again once the device is connected.
77
77
78
-
If you are using Device Provisioning Service (DPS), then ensure that you tag your devices after they are provisioned and not during the Device creation process. If you have already tagged your device during the Device creation step, then you will have to temporarily tag your device with a different value after it is provisioned, and then add your intended tag again.
78
+
If you are using Device Provisioning Service (DPS), then ensure that you tag your devices after they are provisioned and not during the Device creation process. If you already tagged your device during the Device creation step, then you will have to temporarily tag your device with a different value after it is provisioned, and then add your intended tag again.
79
79
80
80
### Q: My deployment completed successfully, but some devices failed to update
81
81
82
-
This may have been caused by a client-side error on the failed devices. Please see the Device Failures section of this troubleshooting guide.
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.
83
83
84
84
### Q: I encountered an error in the UX when trying to initiate a deployment
85
85
86
-
This may have been caused by a service/UX bug, or by an API permissions issue. Please follow the instructions in the [Contacting Microsoft Support](#contact) section to file a support request with Microsoft.
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.
87
87
88
88
### Q: I started a deployment but it isn’t reaching an end state
89
89
90
-
This may have been caused by a service performance issue, a service bug, or a client bug. Please 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, please follow the instructions in the [Contacting Microsoft Support](#contact) section to file a support request with Microsoft.
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.
91
91
92
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
93
93
94
-
This may have been caused if you did not remove the older agent that was communicating over the Device Twin. 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 do 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 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.
0 commit comments