Skip to content

Commit 22bc6ea

Browse files
author
Jill Grant
authored
Merge pull request #269538 from ochimo/velma_spring
Azure CLI & PS Quickstarts, Updates to Tutorial, RBAC, FAQ, and What's New docs for new onboarding experience
2 parents 6200680 + 7a68300 commit 22bc6ea

20 files changed

+410
-40
lines changed

articles/defender-for-iot/device-builders/TOC.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@
1616
- name: Enable Microsoft Defender for IoT on Azure IoT Hub
1717
displayName: IoT Hub, existing, enable, enable, onboard
1818
href: quickstart-onboard-iot-hub.md
19+
- name: Upload Firmware using Azure CLI
20+
displayName: Azure CLI, upload, firmware
21+
href: quickstart-upload-firmware-using-azure-command-line-interface.md
22+
- name: Upload Firmware using Azure PowerShell
23+
displayName: Azure PowerShell, upload, firmware
24+
href: quickstart-upload-firmware-using-powershell.md
1925
- name: Tutorials
2026
items:
2127
- name: Add a resource group to your IoT solution
@@ -65,6 +71,9 @@
6571
- name: Firmware analysis (preview)
6672
displayName: IoT, OT, firmware, analysis
6773
href: overview-firmware-analysis.md
74+
- name: Azure role-based access control for Defender for IoT Firmware analysis
75+
displayName: RBAC, role, access, control, firmware, analysis
76+
href: defender-iot-firmware-analysis-rbac.md
6877
- name: How-to guides
6978
items:
7079
- name: Install Defender for IoT micro agent for Edge

articles/defender-for-iot/device-builders/defender-iot-firmware-analysis-faq.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
---
22
title: Frequently asked questions about Defender for IoT Firmware analysis
3-
description: Find answers to some of the common questions about Defender for IoT Firmware Analysis.
3+
description: Find answers to some of the common questions about Defender for IoT Firmware Analysis. This article includes the file systems that are supported by Defender for IoT Firmware Analysis, and links to the Azure CLI and Azure PowerShell commands.
44
ms.topic: conceptual
55
ms.date: 01/10/2024
66
---
77

88
# Frequently asked questions about Defender for IoT Firmware Analysis
9-
109
This article addresses frequent questions about Defender for IoT Firmware Analysis.
1110

12-
## What is FirmwareAnalysisRG?
13-
**FirmwareAnalysisRG** is the resource group that stores your firmware images. We automatically create **FirmwareAnalysisRG** for you when you register your subscription to the resource provider. To learn more about the **FirmwareAnalysisRG** and how it fits into your resource hierarchy, refer to [Defender for IoT Firmware Analysis RBAC](defender-iot-firmware-analysis-rbac.md#understanding-the-representation-of-firmware-images-in-the-azure-resource-hierarchy).
11+
[Defender for IoT Firmware Analysis](/azure/defender-for-iot/device-builders/overview-firmware-analysis) is a tool that analyzes firmware images and provides an understanding of security vulnerabilities in the firmware images.
1412

1513
## What types of firmware images does Defender for IoT Firmware Analysis support?
1614
Defender for IoT Firmware Analysis supports unencrypted images that contain file systems with embedded Linux operating systems. Defender for IoT Firmware Analysis supports the following file system formats:
@@ -44,3 +42,5 @@ Defender for IoT Firmware Analysis supports unencrypted images that contain file
4442
* ZStandard compressed data
4543
* Zip archive
4644

45+
## Where are the Defender for IoT Firmware Analysis Azure CLI/PowerShell docs?
46+
You can find the documentation for our Azure CLI commands [here](/cli/azure/firmwareanalysis/firmware) and the documentation for our Azure PowerShell commands [here](/powershell/module/az.firmwareanalysis/?#firmwareanalysis).

articles/defender-for-iot/device-builders/defender-iot-firmware-analysis-rbac.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,9 @@ In Defender for IoT Firmware Analysis, the most common roles are Owner, Contribu
1919
## Understanding the Representation of Firmware Images in the Azure Resource Hierarchy
2020
Azure organizes resources into resource hierarchies, which are in a top-down structure, and you can assign roles at each level of the hierarchy. The level at which you assign a role is the "scope," and lower scopes may inherit roles assigned at higher scopes. Learn more about the [levels of hierarchy and how to organize your resources in the hierarchy](/azure/cloud-adoption-framework/ready/azure-setup-guide/organize-resources).
2121

22-
When you register your subscription to the Defender for IoT Firmware Analysis tool, the action automatically creates the **FirmwareAnalysisRG** Resource Group for you. To locate **FirmwareAnalysisRG**, navigate to your **Resource groups** page in the left menu:
23-
24-
:::image type="content" source="media/defender-for-iot-firmware-analysis-rbac/firmware-analysis-rg.png" alt-text="Screenshot of the location of the FirmwareAnalysisRG Resource Group." lightbox="media/defender-for-iot-firmware-analysis-rbac/firmware-analysis-rg.png":::
22+
When you onboard your subscription to Defender for IoT Firmware Analysis and select your resource group, the action automatically creates the **default** resource within your resource group.
2523

26-
In **FirmwareAnalysisRG**, select **Show hidden types** to show the **default** resource. The **default** resource has the **Microsoft.iotfirmwaredefense.workspace** type.
24+
Navigate to your resource group and select **Show hidden types** to show the **default** resource. The **default** resource has the **Microsoft.IoTFirmwareDefense.workspaces** type.
2725

2826
:::image type="content" source="media/defender-for-iot-firmware-analysis-rbac/default-workspace.png" alt-text="Screenshot of the toggle button 'Show hidden types' that reveals a resource named 'default'." lightbox="media/defender-for-iot-firmware-analysis-rbac/default-workspace.png":::
2927

@@ -33,12 +31,12 @@ You can use RBAC at each level of the hierarchy, including at the hidden **defau
3331

3432
Here's the resource hierarchy of Defender for IoT Firmware Analysis:
3533

36-
:::image type="content" source="media/defender-for-iot-firmware-analysis-rbac/resource-hierarchy.png" alt-text="Screenshot of the hidden 'default' resource, of type 'Microsoft.iotfirmwaredefense.workspace'." lightbox="media/defender-for-iot-firmware-analysis-rbac/resource-hierarchy.png":::
34+
:::image type="content" source="media/defender-for-iot-firmware-analysis-rbac/resource-hierarchy.png" alt-text="Diagram that shows the resource hierarchy of firmware images of Defender for IoT Firmware Analysis." lightbox="media/defender-for-iot-firmware-analysis-rbac/resource-hierarchy.png":::
3735

3836
## Apply Azure RBAC
3937

4038
> [!Note]
41-
> To begin using Defender for IoT Firmware Analysis, the user that onboards the subscription onto Defender for IoT Firmware Analysis ***must be*** a subscription Owner or Contributor. Follow the tutorial at [Analyze a firmware image with Microsoft Defender for IoT](../../../articles/defender-for-iot/device-builders/tutorial-analyze-firmware.md) to onboard your subscription. Once you've onboarded your subscription, a user only needs to be a Firmware Analysis Admin to use Defender for IoT Firmware Analysis.
39+
> To begin using Defender for IoT Firmware Analysis, the user that onboards the subscription onto Defender for IoT Firmware Analysis ***must be*** an Owner, Contributor, Firmware Analysis Admin, or Security Admin at the subscription level. Follow the tutorial at [Analyze a firmware image with Microsoft Defender for IoT](../../../articles/defender-for-iot/device-builders/tutorial-analyze-firmware.md#onboard-your-subscription-to-use-defender-for-firmware-analysis) to onboard your subscription. Once you've onboarded your subscription, a user only needs to be a Firmware Analysis Admin to use Defender for IoT Firmware Analysis.
4240
>
4341
4442
As a user of Defender for IoT Firmware Analysis, you may need to perform certain actions for your organization, such as uploading firmware images or sharing analysis results.
@@ -70,14 +68,14 @@ Invite users to the Subscription | Owner at the **Subscription** level (Owner at
7068
To upload firmware images:
7169

7270
* Confirm that you have sufficient permission in [Defender for IoT Firmware Analysis Roles, Scopes, and Capabilities](#defender-for-iot-firmware-analysis-roles-scopes-and-capabilities).
73-
* [Upload a firmware image for analysis](../../../articles/defender-for-iot/device-builders/tutorial-analyze-firmware.md).
71+
* [Upload a firmware image for analysis](../../../articles/defender-for-iot/device-builders/tutorial-analyze-firmware.md#upload-a-firmware-image-for-analysis).
7472

7573
## Invite third parties to interact with your firmware analysis results
76-
You might want to invite someone to interact solely with your firmware analysis results, without allowing access to other parts of your organization (like other resource groups within your subscription). To allow this type of access, invite the user as a Firmware Analysis Admin at the FirmwareAnalysisRG Resource Group level.
74+
You might want to invite someone to interact solely with your firmware analysis results, without allowing access to other parts of your organization (like other resource groups within your subscription). To allow this type of access, invite the user as a Firmware Analysis Admin at the Resource Group level.
7775

78-
To invite a third party, follow the [Assign Azure roles to external users using the Azure portal](../../../articles/role-based-access-control/role-assignments-external-users.md#invite-an-external-user-to-your-directory) tutorial.
76+
To invite a third party, follow the [Assign Azure roles to external guest users using the Azure portal](../../../articles/role-based-access-control/role-assignments-external-users.md#invite-an-external-user-to-your-directory) tutorial.
7977

80-
* In step 3, navigate to the **FirmwareAnalysisRG** Resource Group.
78+
* In step 3, navigate to your resource group.
8179
* In step 7, select the **Firmware Analysis Admin** role.
8280

8381
> [!Note]
-14.8 KB
Loading
-62.7 KB
Loading
199 KB
Loading
-80.9 KB
Loading
87.8 KB
Loading
211 KB
Loading
165 KB
Loading

0 commit comments

Comments
 (0)