Skip to content

Commit b194656

Browse files
authored
Merge pull request #294026 from karengu0/update-name-case
Update 'firmware analysis' casing
2 parents fcbd659 + 18266ab commit b194656

File tree

4 files changed

+35
-31
lines changed

4 files changed

+35
-31
lines changed

articles/firmware-analysis/automate-firmware-analysis-service-principals.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: Use service principals to automate workflows in Firmware analysis
3-
description: Learn about how to use service principals to automate workflows for Firmware Analysis.
2+
title: Use service principals to automate workflows in firmware analysis
3+
description: Learn about how to use service principals to automate workflows for firmware analysis.
44
author: karengu0
55
ms.author: karenguo
66
ms.topic: conceptual
77
ms.date: 11/04/2024
88
ms.service: azure
99
---
1010

11-
# How to Use Service Principals to Automate Workflows in Firmware analysis
11+
# How to Use Service Principals to Automate Workflows in firmware analysis
1212

1313
Many users of the firmware analysis service may need to automate their workflow. The command `az login` creates an interactive login experience with two-factor authentication that makes it difficult for users to fully automate their workflow. A [service principal](/entra/identity-platform/app-objects-and-service-principals) is a secure identity with proper permissions that authenticates to Azure in the command line without requiring two-factor authentication or an interactive log-in. This article explains how to create a service principal and use it to interact with the firmware analysis service. For more information on creating service principals, visit [Create Azure service principals using the Azure CLI](/cli/azure/azure-cli-sp-tutorial-1#create-a-service-principal). To authenticate securely, we recommend creating a service principal and authenticating using certificates. To learn more, visit [Create a service principal containing a certificate using Azure CLI](/cli/azure/azure-cli-sp-tutorial-3).
1414

@@ -44,9 +44,12 @@ Many users of the firmware analysis service may need to automate their workflow.
4444
az login --service-principal --username <CLIENT_ID> --password <SECRET> --tenant <TENANT_ID>
4545
```
4646

47-
6. Once logged in, refer to the following Quickstarts for scripts to interact with the Firmware analysis service via Azure PowerShell, Azure CLI, or Python:
47+
6. Once logged in, refer to the following Quickstarts for scripts to interact with the firmware analysis service via Azure PowerShell, Azure CLI, or Python:
4848
- [Upload firmware using Azure CLI](quickstart-upload-firmware-using-azure-command-line-interface.md)
4949
- [Upload firmware using Azure PowerShell](quickstart-upload-firmware-using-powershell.md)
5050
- [Upload firmware using Python](quickstart-upload-firmware-using-python.md)
51+
5152

52-
53+
#test
54+
test
55+
test

articles/firmware-analysis/firmware-analysis-rbac.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,52 @@
11
---
2-
title: Azure Role-Based Access Control for Firmware analysis
3-
description: Learn about how to use Azure Role-Based Access Control for Firmware Analysis.
2+
title: Azure Role-Based Access Control for firmware analysis
3+
description: Learn about how to use Azure Role-Based Access Control for firmware analysis.
44
author: karengu0
55
ms.author: karenguo
66
ms.topic: conceptual
77
ms.date: 01/10/2024
88
ms.service: azure
99
---
1010

11-
# Overview of Azure Role-Based Access Control for Firmware analysis
12-
As a user of Firmware analysis, you may want to manage access to your firmware image analysis results. Azure Role-Based Access Control (RBAC) is an authorization system that enables you to control who has access to your analysis results, what permissions they have, and at what level of the resource hierarchy. This article explains how to store firmware analysis results in Azure, manage access permissions, and use RBAC to share these results within your organization and with third parties. To learn more about Azure RBAC, visit [What is Azure Role-Based Access Control (Azure RBAC)?](./../role-based-access-control/overview.md).
11+
# Overview of Azure Role-Based Access Control for firmware analysis
12+
As a user of firmware analysis, you may want to manage access to your firmware image analysis results. Azure Role-Based Access Control (RBAC) is an authorization system that enables you to control who has access to your analysis results, what permissions they have, and at what level of the resource hierarchy. This article explains how to store firmware analysis results in Azure, manage access permissions, and use RBAC to share these results within your organization and with third parties. To learn more about Azure RBAC, visit [What is Azure Role-Based Access Control (Azure RBAC)?](./../role-based-access-control/overview.md).
1313

1414
## Roles
1515
Roles are a collection of permissions packaged together. There are two types of roles:
1616

1717
* **Job function roles** give users permission to perform specific job functions or tasks, such as **Key Vault Contributor** or **Azure Kubernetes Service Cluster Monitoring User**.
1818
* **Privileged administrator roles** give elevated access privileges, such as **Owner**, **Contributor**, or **User Access Administrator**. To learn more about roles, visit [Azure built-in roles](./../role-based-access-control/built-in-roles.md).
1919

20-
In Firmware analysis, the most common roles are Owner, Contributor, Security Admin, and Firmware Analysis Admin. Learn more about [which roles you need for different permissions](./firmware-analysis-rbac.md#firmware-analysis-roles-scopes-and-capabilities), such as uploading firmware images or sharing firmware analysis results.
20+
In firmware analysis, the most common roles are Owner, Contributor, Security Admin, and Firmware Analysis Admin. Learn more about [which roles you need for different permissions](./firmware-analysis-rbac.md#firmware-analysis-roles-scopes-and-capabilities), such as uploading firmware images or sharing firmware analysis results.
2121

2222
## Understanding the Representation of Firmware Images in the Azure Resource Hierarchy
2323
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).
2424

25-
When you onboard your subscription to Firmware analysis and select your resource group, the action automatically creates the **default** resource within your resource group.
25+
When you onboard your subscription to firmware analysis and select your resource group, the action automatically creates the **default** resource within your resource group.
2626

2727
Navigate to your resource group and select **Show hidden types** to show the **default** resource. The **default** resource has the **Microsoft.IoTFirmwareDefense.workspaces** type.
2828

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

3131
Although the **default** workspace resource isn't something that you'll regularly interact with, each firmware image that you upload will be represented as a resource and stored here.
3232

33-
You can use RBAC at each level of the hierarchy, including at the hidden **default Firmware Analysis Workspace** resource level.
33+
You can use RBAC at each level of the hierarchy, including at the hidden **default firmware analysis workspace** resource level.
3434

35-
Here's the resource hierarchy of Firmware Analysis:
35+
Here's the resource hierarchy of firmware analysis:
3636

3737
:::image type="content" source="media/firmware-analysis-rbac/resource-hierarchy.png" alt-text="Diagram that shows the resource hierarchy of firmware images of Firmware Analysis." lightbox="media/firmware-analysis-rbac/resource-hierarchy.png":::
3838

3939
## Apply Azure RBAC
4040

4141
> [!Note]
42-
> To begin using Firmware analysis, the user that onboards the subscription onto 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 Firmware analysis](./tutorial-analyze-firmware.md#onboard-your-subscription-to-use-firmware-analysis) to onboard your subscription. Once you've onboarded your subscription, a user only needs to be a Firmware Analysis Admin to use Firmware Analysis.
42+
> To begin using firmware analysis, the user that onboards the subscription onto 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 firmware analysis](./tutorial-analyze-firmware.md#onboard-your-subscription-to-use-firmware-analysis) to onboard your subscription. Once you've onboarded your subscription, a user only needs to be a Firmware Analysis Admin to use firmware analysis.
4343
>
4444
45-
As a user of Firmware analysis, you may need to perform certain actions for your organization, such as uploading firmware images or sharing analysis results.
45+
As a user of firmware analysis, you may need to perform certain actions for your organization, such as uploading firmware images or sharing analysis results.
4646

47-
Actions like these involve Role-Based Access Control (RBAC). To effectively use RBAC for Firmware analysis, you must know what your role assignment is, and at what scope. Knowing this information will inform you about what permissions you have, and thus whether you can complete certain actions. To check your role assignment, refer to [Check access for a user to a single Azure resource - Azure RBAC](./../role-based-access-control/check-access.md). Next, see the following table to check what roles and scopes are necessary for certain actions.
47+
Actions like these involve Role-Based Access Control (RBAC). To effectively use RBAC for firmware analysis, you must know what your role assignment is, and at what scope. Knowing this information will inform you about what permissions you have, and thus whether you can complete certain actions. To check your role assignment, refer to [Check access for a user to a single Azure resource - Azure RBAC](./../role-based-access-control/check-access.md). Next, see the following table to check what roles and scopes are necessary for certain actions.
4848

49-
### Common roles in Firmware analysis
49+
### Common roles in firmware analysis
5050

5151
This table categorizes each role and provides a brief description of their permissions:
5252

@@ -70,7 +70,7 @@ Invite users to the Subscription | Owner at the **Subscription** level (Owner at
7070
## Uploading Firmware images
7171
To upload firmware images:
7272

73-
* Confirm that you have sufficient permission in [Firmware Analysis Roles, Scopes, and Capabilities](#firmware-analysis-roles-scopes-and-capabilities).
73+
* Confirm that you have sufficient permission in [Firmware analysis Roles, Scopes, and Capabilities](#firmware-analysis-roles-scopes-and-capabilities).
7474
* [Upload a firmware image for analysis](./tutorial-analyze-firmware.md#upload-a-firmware-image-for-analysis).
7575

7676
## Invite third parties to interact with your firmware analysis results

articles/firmware-analysis/index.yml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,27 @@ metadata:
1010
author: karengu0
1111
ms.author: karenguo
1212
ms.date: 11/11/2024
13+
ms.service: azure
1314

1415

1516
landingContent:
16-
- title: Get started
17+
- title: Get started
1718
linkLists:
1819
- linkListType: get-started
1920
links:
20-
- text: What is Firmware analysis (preview)?
21+
- text: What is firmware analysis (preview)?
2122
url: overview-firmware-analysis.md
22-
- text: Get started with Firmware analysis in the Azure portal
23+
- text: Get started with firmware analysis in the Azure portal
2324
url: tutorial-analyze-firmware.md
24-
- text: What file systems are supported by Firmware analysis?
25+
- text: What file systems are supported by firmware analysis?
2526
url: firmware-analysis-faq.md#what-types-of-firmware-images-does-firmware-analysis-support
2627
- linkListType: concept
2728
links:
28-
- text: What roles and permissions are needed to use Firmware analysis?
29+
- text: What roles and permissions are needed to use firmware analysis?
2930
url: firmware-analysis-rbac.md
3031
- linkListType: whats-new
3132
links:
32-
- text: What's new in Firmware analysis (preview)?
33+
- text: What's new in firmware analysis (preview)?
3334
url: release-notes.md
3435

3536
- title: Automate your workflow
@@ -45,11 +46,11 @@ landingContent:
4546
- text: Analyze firmware images using a Python script
4647
url: quickstart-upload-firmware-using-python.md
4748

48-
- title: Understand the Firmware analysis service
49+
- title: Understand the firmware analysis service
4950
linkLists:
5051
- linkListType: concept
5152
links:
52-
- text: Understand the resource hierarchy of Firmware analysis
53+
- text: Understand the resource hierarchy of firmware analysis
5354
url: firmware-analysis-rbac.md#understanding-the-representation-of-firmware-images-in-the-azure-resource-hierarchy
5455
- text: Understand and interpret the extractor path results
5556
url: interpreting-extractor-paths.md

articles/firmware-analysis/toc.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
- name: "Overview"
55
items:
6-
- name: Overview of Firmware analysis (preview)
6+
- name: Overview of firmware analysis (preview)
77
href: overview-firmware-analysis.md
88
- name: Firmware analysis frequently asked questions
99
href: firmware-analysis-faq.md
@@ -12,14 +12,14 @@
1212
expanded: true
1313
- name: Quickstarts
1414
items:
15-
- name: Quickstart to use Firmware analysis with Azure CLI
15+
- name: Quickstart to use firmware analysis with Azure CLI
1616
href: quickstart-upload-firmware-using-azure-command-line-interface.md
17-
- name: Quickstart to use Firmware analysis with Azure PowerShell
17+
- name: Quickstart to use firmware analysis with Azure PowerShell
1818
href: quickstart-upload-firmware-using-powershell.md
19-
- name: Quickstart to use Firmware analysis with a Python script
19+
- name: Quickstart to use firmware analysis with a Python script
2020
href: quickstart-upload-firmware-using-python.md
2121
expanded: true
22-
- name: Tutorial using Firmware analysis with the Azure portal
22+
- name: Tutorial using firmware analysis with the Azure portal
2323
href: tutorial-analyze-firmware.md
2424
- name: Concepts
2525
items:

0 commit comments

Comments
 (0)