Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache License, Version 2.0 (the ""License"");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an ""AS IS"" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
// is regenerated.

using System;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")]
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - FirmwareAnalysis")]
[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.4")]
[assembly: System.Reflection.AssemblyVersionAttribute("0.1.4")]
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
[assembly: System.CLSCompliantAttribute(false)]

16 changes: 3 additions & 13 deletions src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ For information on how to develop for `Az.FirmwareAnalysis`, see [how-to.md](how

```yaml
# pin the swagger version by using the commit id instead of branch name
commit: ef348fed285ae01b78cf6afd394ad2c4c8b6da7e
commit: 04b87408ba3b8afed159b3d3059bd1594c7f2dd3
require:
# readme.azure.noprofile.md is the common configuration file
- $(this-folder)/../../readme.azure.noprofile.md
Expand All @@ -39,23 +39,13 @@ require:
# - (this-folder)/relative-path-to-your-local-readme.md

input-file:
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/firmwares.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/workspaces.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/binaryHardeningResults.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/sbomComponents.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cves.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoCertificates.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/cryptoKeys.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/passwordHashes.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/summaries.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/common.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2024-01-10/operations.json
- $(repo)/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/stable/2025-08-02/iotfirmwaredefense.json
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this swagger the merge of all the previously referenced swaggers? Are there any gaps in APIs?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, when we changed to typespec generating the swagger it output a single file instead of all the handwritten swaggers we had before


try-require:
- /swagger/fist/resource-manager/readme.powershell.md

# For new RP, the version is 0.1.0
module-version: 0.1.0
module-version: 0.2.0
# Normally, title is the service name
title: FirmwareAnalysis
subject-prefix: $(service-name)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"resourceType": "workspaces/firmwares/summaries",
"apiVersion": "2024-01-10",
"apiVersion": "2025-08-02",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.firmwareanalysis"
},
"commands": [
{
"name": "Get-AzFirmwareAnalysisSummary",
"description": "Get an analysis result summary of a firmware by name.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/summaries/{summaryName}",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/firmwares/{firmwareId}/summaries/{summaryType}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysissummary"
Expand All @@ -17,9 +17,9 @@
{
"parameters": [
"-FirmwareId <String>",
"-Name <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String[]>]",
"-Type <String>",
"-WorkspaceName <String>"
]
}
Expand All @@ -33,10 +33,6 @@
"name": "-FirmwareId",
"value": "[Path.firmwareId]"
},
{
"name": "-Name",
"value": "[Path.summaryName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
Expand All @@ -45,6 +41,10 @@
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
},
{
"name": "-Type",
"value": "[Path.summaryType]"
},
{
"name": "-WorkspaceName",
"value": "[Path.workspaceName]"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "workspaces/firmwares",
"apiVersion": "2024-01-10",
"apiVersion": "2025-08-02",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.firmwareanalysis"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"resourceType": "workspaces/usageMetrics",
"apiVersion": "2025-08-02",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.firmwareanalysis"
},
"commands": [
{
"name": "Get-AzFirmwareAnalysisUsageMetric",
"description": "Gets monthly usage information for a workspace.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/usageMetrics/{name}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysisusagemetric"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String[]>]",
"-WorkspaceName <String>"
]
}
]
},
"examples": [
{
"description": "Gets monthly usage information for a workspace.",
"parameters": [
{
"name": "-Name",
"value": "[Path.name]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
},
{
"name": "-WorkspaceName",
"value": "[Path.workspaceName]"
}
]
}
]
}
]
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "workspaces",
"apiVersion": "2024-01-10",
"apiVersion": "2025-08-02",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.firmwareanalysis"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
Module Name: Az.FirmwareAnalysis
Module Guid: e097ff3f-acb2-48da-86fe-937d86006ea5
Module Guid: 5b4de3cc-6dec-4f20-9ee5-ebc729b9a384
Download Help Link: https://learn.microsoft.com/powershell/module/az.firmwareanalysis
Help Version: 1.0.0.0
Locale: en-US
Expand All @@ -15,10 +15,10 @@ Microsoft Azure PowerShell: FirmwareAnalysis cmdlets
Lists binary hardening analysis results of a firmware.

### [Get-AzFirmwareAnalysisCryptoCertificate](Get-AzFirmwareAnalysisCryptoCertificate.md)
Lists cryptographic certificate analysis results found in a firmware.
Lists crypto certificate analysis results of a firmware.

### [Get-AzFirmwareAnalysisCryptoKey](Get-AzFirmwareAnalysisCryptoKey.md)
Lists cryptographic key analysis results found in a firmware.
Lists crypto key analysis results of a firmware.

### [Get-AzFirmwareAnalysisCve](Get-AzFirmwareAnalysisCve.md)
Lists CVE analysis results of a firmware.
Expand All @@ -30,22 +30,25 @@ Get firmware.
Lists password hash analysis results of a firmware.

### [Get-AzFirmwareAnalysisSbomComponent](Get-AzFirmwareAnalysisSbomComponent.md)
Lists SBOM analysis results of a firmware.
Lists sbom analysis results of a firmware.

### [Get-AzFirmwareAnalysisSummary](Get-AzFirmwareAnalysisSummary.md)
Get an analysis result summary of a firmware by name.

### [Get-AzFirmwareAnalysisUsageMetric](Get-AzFirmwareAnalysisUsageMetric.md)
Gets monthly usage information for a workspace.

### [Get-AzFirmwareAnalysisWorkspace](Get-AzFirmwareAnalysisWorkspace.md)
Get firmware analysis workspace.

### [New-AzFirmwareAnalysisFirmware](New-AzFirmwareAnalysisFirmware.md)
The operation to Create a firmware.
The operation to create a firmware.

### [New-AzFirmwareAnalysisWorkspace](New-AzFirmwareAnalysisWorkspace.md)
The operation to Create a firmware analysis workspace.
The operation to create a firmware analysis workspace.

### [New-AzFirmwareAnalysisWorkspaceUploadUrl](New-AzFirmwareAnalysisWorkspaceUploadUrl.md)
The operation to get a url for file upload.
Generate a URL for uploading a firmware image.

### [Remove-AzFirmwareAnalysisFirmware](Remove-AzFirmwareAnalysisFirmware.md)
The operation to delete a firmware.
Expand All @@ -54,8 +57,8 @@ The operation to delete a firmware.
The operation to delete a firmware analysis workspace.

### [Update-AzFirmwareAnalysisFirmware](Update-AzFirmwareAnalysisFirmware.md)
The operation to Update firmware.
The operation to update firmware.

### [Update-AzFirmwareAnalysisWorkspace](Update-AzFirmwareAnalysisWorkspace.md)
The operation to Update a firmware analysis workspaces.
The operation to update a firmware analysis workspaces.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzFirmwareAnalysisCryptoCertificate

## SYNOPSIS
Lists cryptographic certificate analysis results found in a firmware.
Lists crypto certificate analysis results of a firmware.

## SYNTAX

Expand All @@ -18,7 +18,7 @@ Get-AzFirmwareAnalysisCryptoCertificate -FirmwareId <String> -ResourceGroupName
```

## DESCRIPTION
Lists cryptographic certificate analysis results found in a firmware.
Lists crypto certificate analysis results of a firmware.

## EXAMPLES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzFirmwareAnalysisCryptoKey

## SYNOPSIS
Lists cryptographic key analysis results found in a firmware.
Lists crypto key analysis results of a firmware.

## SYNTAX

Expand All @@ -18,7 +18,7 @@ Get-AzFirmwareAnalysisCryptoKey -FirmwareId <String> -ResourceGroupName <String>
```

## DESCRIPTION
Lists cryptographic key analysis results found in a firmware.
Lists crypto key analysis results of a firmware.

## EXAMPLES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzFirmwareAnalysisSbomComponent

## SYNOPSIS
Lists SBOM analysis results of a firmware.
Lists sbom analysis results of a firmware.

## SYNTAX

Expand All @@ -18,7 +18,7 @@ Get-AzFirmwareAnalysisSbomComponent -FirmwareId <String> -ResourceGroupName <Str
```

## DESCRIPTION
Lists SBOM analysis results of a firmware.
Lists sbom analysis results of a firmware.

## EXAMPLES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Get an analysis result summary of a firmware by name.

### Get (Default)
```
Get-AzFirmwareAnalysisSummary -FirmwareId <String> -Name <String> -ResourceGroupName <String>
Get-AzFirmwareAnalysisSummary -FirmwareId <String> -ResourceGroupName <String> -Type <String>
-WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]
```

Expand All @@ -26,13 +26,13 @@ Get-AzFirmwareAnalysisSummary -InputObject <IFirmwareAnalysisIdentity> [-Default

### GetViaIdentityFirmware
```
Get-AzFirmwareAnalysisSummary -FirmwareInputObject <IFirmwareAnalysisIdentity> -Name <String>
Get-AzFirmwareAnalysisSummary -FirmwareInputObject <IFirmwareAnalysisIdentity> -Type <String>
[-DefaultProfile <PSObject>] [<CommonParameters>]
```

### GetViaIdentityWorkspace
```
Get-AzFirmwareAnalysisSummary -FirmwareId <String> -Name <String>
Get-AzFirmwareAnalysisSummary -FirmwareId <String> -Type <String>
-WorkspaceInputObject <IFirmwareAnalysisIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>]
```

Expand All @@ -43,7 +43,7 @@ Get an analysis result summary of a firmware by name.

### Example 1: List all the analysis results summary for a firmware by analysis type CVE.
```powershell
Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Name Type
Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Type CVE
```

```output
Expand All @@ -65,7 +65,7 @@ List all the analysis results summary for a firmware by analysis type CVE.

### Example 2: List all the analysis results summary for a firmware by analysis type Firmware.
```powershell
Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Name Type
Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Type Firmware
```

```output
Expand Down Expand Up @@ -148,21 +148,6 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```

### -Name
The Firmware analysis summary name describing the type of summary.

```yaml
Type: System.String
Parameter Sets: Get, GetViaIdentityFirmware, GetViaIdentityWorkspace
Aliases: SummaryName

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ResourceGroupName
The name of the resource group.
The name is case insensitive.
Expand Down Expand Up @@ -195,6 +180,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -Type
The Firmware analysis summary name describing the type of summary.

```yaml
Type: System.String
Parameter Sets: Get, GetViaIdentityFirmware, GetViaIdentityWorkspace
Aliases: SummaryType

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WorkspaceInputObject
Identity Parameter

Expand Down
Loading