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/firmware-analysis/firmware-analysis-integration-with-azure-device-registry.md
+39-41Lines changed: 39 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,52 +10,50 @@ ms.service: azure
10
10
11
11
# Using Firmware analysis along with Azure Device Registry
12
12
13
-
## Firmware analysis and Azure Device Registry integration
14
-
15
-
Azure Device Registry (ADR) maintains an inventory of two types of resources: Assets and Devices. Firmware images will be mapped to both types of ADR resources.
13
+
Azure Device Registry (Azure Device Registry) maintains an inventory of two types of resources: Assets and Devices. Firmware images will be mapped to both types of Azure Device Registry resources.
16
14
17
15
- Assets are managed by Azure IoT Operations
18
16
- An example of an asset managed by Azure IoT Operations could be an oven in a bakery.
19
17
- Devices are managed by Azure IoT Hub (preview) and Azure IoT Operations
20
18
- Examples of devices managed by Azure IoT Hub could be cameras or wind turbines.
21
19
22
-
Firmware analysis and ADR operate as complementary Azure services. Firmware analysis evaluates the security of firmware images, while ADR tracks deployed devices and assets and their associated metadata. To learn more about ADR, visit Integration with Azure Device Registry (preview).
20
+
Firmware analysis and Azure Device Registry operate as complementary Azure services. Firmware analysis evaluates the security of firmware images, while Azure Device Registry tracks deployed devices and assets and their associated metadata. To learn more about Azure Device Registry, visit [Integration with Azure Device Registry (preview)](./../iot-hub/iot-hub-device-registry-overview.md).
23
21
24
-
The Firmware analysis and ADR integration associates firmware analysis results with ADR managed devices and assets based on shared metadata values. This association enables users to have a comprehensive understanding of the security posture of the firmware across your ADR-managed devices fleet. With this integration, you can now know which devices are impacted by critical vulnerabilities in your firmware images and take the necessary actions to remediate risk across your ADR device fleet.
22
+
The Firmware analysis and Azure Device Registry integration associates firmware analysis results with Azure Device Registry managed devices and assets based on shared metadata values. This association enables users to have a comprehensive understanding of the security posture of the firmware across your Azure Device Registry-managed devices fleet. With this integration, you can now know which devices are impacted by critical vulnerabilities in your firmware images and take the necessary actions to remediate risk across your Azure Device Registry device fleet.
25
23
26
24
27
25
## Metadata-based association
28
26
29
-
Firmware analysis associates firmware images with ADR devices and assets by matching firmware metadata defined during firmware upload with ADR resource metadata. This association occurs at the subscription level. Firmware analysis matches ADR devices and assets in the same subscription as the Firmware analysis workspace.
27
+
Firmware analysis associates firmware images with Azure Device Registry devices and assets by matching firmware metadata defined during firmware upload with Azure Device Registry resource metadata. This association occurs at the subscription level. Firmware analysis matches Azure Device Registry devices and assets in the same subscription as the Firmware analysis workspace.
30
28
31
29
When a firmware image is uploaded to Firmware analysis, the following metadata is specified:
32
30
33
31
- Vendor
34
32
- Model
35
33
- Firmware version
36
34
37
-
ADR maintains corresponding metadata for devices and assets. This integration establishes associations between firmware analysis results and ADR resources by matching these metadata fields across both services.
35
+
Azure Device Registry maintains corresponding metadata for devices and assets. This integration establishes associations between firmware analysis results and Azure Device Registry resources by matching these metadata fields across both services.
38
36
39
-
The following metadata values are used to associate firmware images with ADR resources:
37
+
The following metadata values are used to associate firmware images with Azure Device Registry resources:
| Version | Operating system version (Devices) or Software revision (Assets) |
46
44
47
-
When metadata values match between a firmware image and an ADR device or asset, the ADR resource is associated with that firmware image for the purpose of reporting firmware analysis results for that ADR resource.
45
+
When metadata values match between a firmware image and an Azure Device Registry device or asset, the Azure Device Registry resource is associated with that firmware image for the purpose of reporting firmware analysis results for that Azure Device Registry resource.
48
46
49
47
50
-
## Ensuring metadata in Firmware analysis and ADR match each other
48
+
## Ensure metadata in Firmware analysis and Azure Device Registry match each other
51
49
52
-
Because the firmware images are mapped to the ADR resources and vice versa using metadata from both, be sure to keep your metadata fields up-to-date so that the list of ADR resources associated with each firmware image is comprehensive.
50
+
Because the firmware images are mapped to the Azure Device Registry resources and vice versa using metadata from both, be sure to keep your metadata fields up-to-date so that the list of Azure Device Registry resources associated with each firmware image is comprehensive.
53
51
54
52
To update your metadata fields in Firmware analysis, navigate to your firmware image in Firmware analysis, and edit the metadata fields.
55
53
56
54
:::image type="content" source="media/device-registry-integration/update-metadata.png" alt-text="Screenshot of the update metadata icon." lightbox="media/device-registry-integration/update-metadata.png":::
57
55
58
-
To update your metadata fields in ADR for your ADR Devices, run the following command:
56
+
To update your metadata fields in Azure Device Registry for your Azure Device Registry Devices, run the following command:
To update your metadata fields in ADR for your ADR Assets, visit the Digital Operations Experience. For more information, see Manage resources in the operations experience UI - Azure IoT Operations.
77
+
To update your metadata fields in Azure Device Registry for your Azure Device Registry Assets, visit the Digital Operations Experience. For more information, see [Manage resources in the operations experience UI - Azure IoT Operations](./../iot-operations/discover-manage-assets/howto-use-operations-experience.md).
80
78
81
79
82
-
## Where to find ADR resource information in Firmware analysis
80
+
## Where to find Azure Device Registry resource information in Firmware analysis
83
81
84
-
Firmware analysis surfaces ADR device and asset information associated with a firmware image in the following areas:
82
+
Firmware analysis surfaces Azure Device Registry device and asset information associated with a firmware image in the following areas:
85
83
86
84
- Firmware image list view in a Workspace
87
-
Includes a Devices & assets column that shows the number of ADR-managed resources associated with that firmware image
85
+
Includes a Devices & assets column that shows the number of Azure Device Registry-managed resources associated with that firmware image
88
86
89
87
- Firmware Overview right-hand pop-up in firmware list
90
88
Displays two fields: “Devices” and “Assets” count associated with the firmware image
91
89
92
90
:::image type="content" source="media/device-registry-integration/devices-assets-firmware-list-popup.png" alt-text="Screenshot of the Devices and Assets list in the firmware list popup." lightbox="media/device-registry-integration/devices-assets-firmware-list-popup.png":::
93
91
94
-
- Hover over the number to see a scrollable list of ADR Devices or Assets, each linking to that ADR resource’s Resource Overview page in the ADR portal
92
+
- Hover over the number to see a scrollable list of Azure Device Registry Devices or Assets, each linking to that Azure Device Registry resource’s Resource Overview page in the Azure Device Registry portal
95
93
96
94
- Analysis results Azure Device Registry section
97
-
-ADR fields “Devices” and “Assets” that displays ADR-associated devices and assets alongside firmware analysis findings
95
+
-Azure Device Registry fields “Devices” and “Assets” that displays Azure Device Registry-associated devices and assets alongside firmware analysis findings
98
96
99
97
:::image type="content" source="media/device-registry-integration/devices-assets-firmware-details.png" alt-text="Screenshot of the Devices and Assets fields in firmware analysis findings." lightbox="media/device-registry-integration/devices-assets-firmware-details.png":::
100
98
101
-
- Like the experience in the Overview panel pop-up, hover over the number to see a scrollable list of ADR resources, each linking to that resource’s Resource Overview page in the ADR portal
99
+
- Like the experience in the Overview panel pop-up, hover over the number to see a scrollable list of Azure Device Registry resources, each linking to that resource’s Resource Overview page in the Azure Device Registry portal
102
100
103
-
:::image type="content" source="media/device-registry-integration/hover-list.png" alt-text="Screenshot of the scrollable list upon hovering over ADR resources." lightbox="media/device-registry-integration/hover-list.png":::
101
+
:::image type="content" source="media/device-registry-integration/hover-list.png" alt-text="Screenshot of the scrollable list upon hovering over Azure Device Registry resources." lightbox="media/device-registry-integration/hover-list.png":::
104
102
105
-
From Firmware analysis, you can select an ADR resource to be taken to the ADR resource overview page in the ADR portal.
103
+
From Firmware analysis, you can select an Azure Device Registry resource to be taken to the Azure Device Registry resource overview page in the Azure Device Registry portal.
106
104
107
105
---
108
106
109
107
## Access requirements
110
108
111
-
Access to ADR associated device and asset information is governed by Azure role based access control (RBAC).
109
+
Access to Azure Device Registry associated device and asset information is governed by Azure role based access control (RBAC).
112
110
113
-
Firmware analysis roles do not automatically grant access to ADR resources. Users of Firmware analysis with the Firmware Analysis Admin role do not have proper permissions to view the list of ADR devices. Users must also have appropriate ADR permissions to view:
111
+
Firmware analysis roles do not automatically grant access to Azure Device Registry resources. Users of Firmware analysis with the Firmware Analysis Admin role do not have proper permissions to view the list of Azure Device Registry devices. Users must also have appropriate Azure Device Registry permissions to view:
114
112
115
-
-ADR device lists
116
-
-ADR asset metadata
117
-
-ADR resource details in the ADR portal
113
+
-Azure Device Registry device lists
114
+
-Azure Device Registry asset metadata
115
+
-Azure Device Registry resource details in the Azure Device Registry portal
118
116
119
-
ADR-associated information might not be visible if the user does not have the required ADR permissions, even when metadata values match. Ensure you have both of the following roles:
117
+
Azure Device Registry-associated information might not be visible if the user does not have the required Azure Device Registry permissions, even when metadata values match. Ensure you have both of the following roles:
120
118
121
-
- Azure Device Registry Contributor, which allows you to read ADR namespaces
122
-
- Azure IoT Operations Administrator, which allows you to read ADR Assets and Devices in the ADR namespaces
119
+
- Azure Device Registry Contributor, which allows you to read Azure Device Registry namespaces
120
+
- Azure IoT Operations Administrator, which allows you to read Azure Device Registry Assets and Devices in the Azure Device Registry namespaces
123
121
124
-
Additionally, the Reader role at the subscription level allows you to read both namespaces and ADR Assets and Devices.
122
+
Additionally, the Reader role at the subscription level allows you to read both namespaces and Azure Device Registry Assets and Devices.
125
123
126
-
| Role | Permission to read namespaces? | Permission to read ADR Assets? | Permission to read ADR Devices? |
124
+
| Role | Permission to read namespaces? | Permission to read Azure Device Registry Assets? | Permission to read Azure Device Registry Devices? |
Ensure you have the Firmware Analysis Admin role in addition to the appropriate ADR roles to see ADR-associated information.
130
+
Ensure you have the Firmware Analysis Admin role in addition to the appropriate Azure Device Registry roles to see Azure Device Registry-associated information.
133
131
134
-
## Why am I not seeing any ADR Devices or Assets?
132
+
## Why am I not seeing any Azure Device Registry Devices or Assets?
135
133
136
-
If ADR device or asset counts are not visible for a firmware image, it may be due to one of the following:
134
+
If Azure Device Registry device or asset counts are not visible for a firmware image, it may be due to one of the following:
137
135
138
-
- Insufficient permissions – Your Azure role may not have permission to read ADR devices and/or assets. In this case, counts may appear blank (–) or partially populated.
136
+
- Insufficient permissions – Your Azure role may not have permission to read Azure Device Registry devices and/or assets. In this case, counts may appear blank (–) or partially populated.
139
137
140
-
- Missing firmware metadata – ADR correlation requires Vendor, Model, and Version fields. If these are not populated accurately in both Firmware analysis and ADR, device and asset usage cannot be determined.
138
+
- Missing firmware metadata – Azure Device Registry correlation requires Vendor, Model, and Version fields. If these are not populated accurately in both Firmware analysis and Azure Device Registry, device and asset usage cannot be determined.
141
139
142
-
- Temporary query failure – ADR results are retrieved using Azure Resource Graph (ARG). Counts may appear empty if a query error occurs. Refreshing the page might resolve this.
140
+
- Temporary query failure – Azure Device Registry results are retrieved using Azure Resource Graph (ARG). Counts may appear empty if a query error occurs. Refreshing the page might resolve this.
143
141
144
142
145
143
## Current limitations
146
144
147
145
The initial preview version of this integration:
148
146
149
-
- Displays ADR device and asset count
150
-
- Displays results by using Azure Resource Graph. Changes to metadata for ADR Devices and Assets might take a few minutes to appear in Firmware analysis
151
-
- Provides navigation to individual ADR resources instead of a prefiltered ADR device list view
147
+
- Displays Azure Device Registry device and asset count
148
+
- Displays results by using Azure Resource Graph. Changes to metadata for Azure Device Registry Devices and Assets might take a few minutes to appear in Firmware analysis
149
+
- Provides navigation to individual Azure Device Registry resources instead of a pre-filtered Azure Device Registry device list view
0 commit comments