Merge pull request #290301 from karengu0/velma-docs-nov

Add 'Preview' label

Author: v-dirichards

articles/defender-for-iot/device-builders/tutorial-analyze-firmware.md

@@ -30,7 +30,7 @@ To use the **Firmware analysis** page to analyze your firmware security, your fi
 
 - Your image must be an unencrypted, Linux-based firmware image.
 
-- Your image must be less than 5 GB in size.
+- Your image must be less than 1 GB in size.
 
 ## Onboard your subscription to use Defender for Firmware Analysis
 > [!NOTE]

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

@@ -9,15 +9,15 @@ ms.date: 11/04/2024
 
 # How to Use Service Principals to Automate Workflows in Firmware analysis
 
-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 [Apps & service principals in Microsoft Entra ID](/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).
+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).
 
-1. Log in to your Azure account using the portal.
+1. Log in to your Azure account using the Azure portal.
 
 2. Navigate to your subscription and assign yourself `User Access Administrator` or `Role Based Access Control Administrator` permissions, or higher, in your subscription. This gives you permission to create a service principal.
 
 3.	Navigate to your command line
 
-    1. Log in, specifying the tenant ID during login
+    1. Log in, specifying your tenant ID during login
 
         ```azurecli
         az login --tenant <TENANT_ID>
@@ -40,7 +40,7 @@ Many users of the firmware analysis service may need to automate their workflow.
 5.	Log in to your service principal
 
     ```azurecli
-    az login --service-principal --username $clientID --password $secret --tenant $tenantID
+    az login --service-principal --username <CLIENT_ID> --password <SECRET> --tenant <TENANT_ID>
     ```
 
 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:

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

@@ -22,7 +22,7 @@ In Firmware analysis, the most common roles are Owner, Contributor, Security Adm
 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).
 
 When you onboard your subscription to Firmware analysis and select your resource group, the action automatically creates the **default** resource within your resource group.
- 
+
 Navigate to your resource group and select **Show hidden types** to show the **default** resource. The **default** resource has the **Microsoft.IoTFirmwareDefense.workspaces** type.
 
 :::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":::

articles/firmware-analysis/index.yml

@@ -0,0 +1,56 @@
+### YamlMime:Landing
+
+title: Firmware analysis (preview)
+summary: Analyze your firmware images for security vulnerabilities
+
+metadata:
+  title: Firmware analysis (preview)
+  description: Analyze your firmware images for security vulnerabilities
+  ms.topic: landing-page
+  author: karengu0
+  ms.author: karenguo
+  ms.date: 11/11/2024
+
+
+landingContent:
+  - title: Get started
+    linkLists:
+      - linkListType: get-started
+        links:
+          - text: What is Firmware analysis (preview)?
+            url: overview-firmware-analysis.md
+          - text: Get started with Firmware analysis in the Azure portal
+            url: tutorial-analyze-firmware.md
+          - text: What file systems are supported by Firmware analysis?
+            url: firmware-analysis-faq.md#what-types-of-firmware-images-does-firmware-analysis-support
+      - linkListType: concept
+        links:
+          - text: What roles and permissions are needed to use Firmware analysis?
+            url: firmware-analysis-rbac.md
+      - linkListType: whats-new
+        links:
+          - text: What's new in Firmware analysis (preview)?
+            url: release-notes.md
+
+  - title: Automate your workflow
+    linkLists:
+      - linkListType: how-to-guide
+        links:
+          - text: Automate your workflow using service principals
+            url: automate-firmware-analysis-service-principals.md
+          - text: Analyze firmware images using Azure CLI commands
+            url: quickstart-upload-firmware-using-azure-command-line-interface.md
+          - text: Analyze firmware images using Azure PowerShell commands
+            url: quickstart-upload-firmware-using-powershell.md
+          - text: Analyze firmware images using a Python script
+            url: quickstart-upload-firmware-using-python.md
+
+  - title: Understand the Firmware analysis service
+    linkLists:
+      - linkListType: concept
+        links:
+          - text: Understand the resource hierarchy of Firmware analysis
+            url: firmware-analysis-rbac.md#understanding-the-representation-of-firmware-images-in-the-azure-resource-hierarchy
+          - text: Understand and interpret the extractor path results
+            url: interpreting-extractor-paths.md
+

articles/firmware-analysis/overview-firmware-analysis.md

@@ -8,7 +8,7 @@ ms.author: karenguo
 #Customer intent: As a device builder, I want to understand how firmware analysis can help secure my IoT/OT devices and products.
 ---
 
-# Firmware analysis
+# What is Firmware analysis (preview)?
 
 Just like computers have operating systems, IoT devices have firmware, and it's the firmware that runs and controls IoT devices. For IoT device builders, security is a near-universal concern as IoT devices have traditionally lacked basic security measures.
 

articles/firmware-analysis/toc.yml

@@ -1,11 +1,15 @@
+- name: Firmware analysis (preview)
+  href: index.yml
+
 - name: "Overview"
   items:
-  - name: Overview of Firmware analysis
+  - name: Overview of Firmware analysis (preview)
     href: overview-firmware-analysis.md
   - name: Firmware analysis frequently asked questions
     href: firmware-analysis-faq.md
   - name: What's new?
     href: release-notes.md
+  expanded: true
 - name: Quickstarts
   items:
   - name: Quickstart to use Firmware analysis with Azure CLI
@@ -14,6 +18,7 @@
     href: quickstart-upload-firmware-using-powershell.md
   - name: Quickstart to use Firmware analysis with a Python script
     href: quickstart-upload-firmware-using-python.md
+  expanded: true
 - name: Tutorial using Firmware analysis with the Azure portal
   href: tutorial-analyze-firmware.md
 - name: Concepts

articles/firmware-analysis/tutorial-analyze-firmware.md

@@ -32,7 +32,7 @@ To use the **Firmware analysis** page to analyze your firmware security, your fi
 
 - Your image must be an unencrypted, Linux-based firmware image.
 
-- Your image must be less than 5 GB in size.
+- Your image must be less than 1 GB in size.
 
 ## Onboard your subscription to use Firmware analysis
 > [!NOTE]

articles/iot/index.yml

@@ -97,7 +97,7 @@ conceptualContent:
           text: Update your devices
         - url: ../firmware-analysis/overview-firmware-analysis.md
           itemType: overview
-          text: Device firmware analysis
+          text: Device firmware analysis (preview)
     # Card
     - title: Process and route messages
       links: