Skip to content

Commit

Permalink
Fix documentation for firmwareanalysis ps
Browse files Browse the repository at this point in the history
  • Loading branch information
kalpeshbhatia000 committed Feb 21, 2024
1 parent a2140dd commit 1d7d21c
Show file tree
Hide file tree
Showing 40 changed files with 430 additions and 245 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
DotNetFrameworkVersion = '4.7.2'
RequiredAssemblies = './bin/Az.FirmwareAnalysis.private.dll'
FormatsToProcess = './Az.FirmwareAnalysis.format.ps1xml'
FunctionsToExport = 'Get-AzFirmwareAnalysisBinaryHardening', 'Get-AzFirmwareAnalysisCryptoCertificate', 'Get-AzFirmwareAnalysisCryptoKey', 'Get-AzFirmwareAnalysisCve', 'Get-AzFirmwareAnalysisFirmware', 'Get-AzFirmwareAnalysisPasswordHash', 'Get-AzFirmwareAnalysisSbomComponent', 'Get-AzFirmwareAnalysisSummary', 'Get-AzFirmwareAnalysisWorkspace', 'New-AzFirmwareAnalysisFirmware', 'New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl', 'New-AzFirmwareAnalysisWorkspace', 'New-AzFirmwareAnalysisWorkspaceUploadUrl', 'Remove-AzFirmwareAnalysisFirmware', 'Remove-AzFirmwareAnalysisWorkspace', 'Update-AzFirmwareAnalysisFirmware', 'Update-AzFirmwareAnalysisWorkspace'
FunctionsToExport = 'Get-AzFirmwareAnalysisBinaryHardening', 'Get-AzFirmwareAnalysisCryptoCertificate', 'Get-AzFirmwareAnalysisCryptoKey', 'Get-AzFirmwareAnalysisCve', 'Get-AzFirmwareAnalysisFirmware', 'Get-AzFirmwareAnalysisPasswordHash', 'Get-AzFirmwareAnalysisSbomComponent', 'Get-AzFirmwareAnalysisSummary', 'Get-AzFirmwareAnalysisWorkspace', 'New-AzFirmwareAnalysisFirmware', 'New-AzFirmwareAnalysisFirmwareDownloadUrl', 'New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl', 'New-AzFirmwareAnalysisWorkspace', 'New-AzFirmwareAnalysisWorkspaceUploadUrl', 'Remove-AzFirmwareAnalysisFirmware', 'Remove-AzFirmwareAnalysisWorkspace', 'Update-AzFirmwareAnalysisFirmware', 'Update-AzFirmwareAnalysisWorkspace'
PrivateData = @{
PSData = @{
Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'FirmwareAnalysis'
Expand Down
14 changes: 11 additions & 3 deletions src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
This directory contains the PowerShell module for the FirmwareAnalysis service.

---
## Status
[![Az.FirmwareAnalysis](https://img.shields.io/powershellgallery/v/Az.FirmwareAnalysis.svg?style=flat-square&label=Az.FirmwareAnalysis "Az.FirmwareAnalysis")](https://www.powershellgallery.com/packages/Az.FirmwareAnalysis/)

## Info
- Modifiable: yes
- Generated: all
Expand Down Expand Up @@ -89,6 +86,17 @@ directive:
verb: Set
remove: true

- where:
verb: New
subject: FirmwareDownloadUrl
remove: true

- where:
verb: Get
subject: Summary
variant: List
remove: true

- where:
parameter-name: Id
verb: New
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ Get firmware analysis workspace.
### [New-AzFirmwareAnalysisFirmware](New-AzFirmwareAnalysisFirmware.md)
The operation to create a firmware.

### [New-AzFirmwareAnalysisFirmwareDownloadUrl](New-AzFirmwareAnalysisFirmwareDownloadUrl.md)
The operation to a url for file download.

### [New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl](New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md)
The operation to a url for tar file download.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,12 @@ Lists binary hardening analysis results of a firmware.

## EXAMPLES

### Example 1: {{ List all the binary hardening analysis results for a firmware.}}
### Example 1: List all the binary hardening analysis results for a firmware.
```powershell
{{ Get-AzFirmwareAnalysisBinaryHardening -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json }}
Get-AzFirmwareAnalysisBinaryHardening -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json
```

```output
{{
[
{
"Architecture": "",
Expand All @@ -53,11 +52,9 @@ Lists binary hardening analysis results of a firmware.
"Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/binaryHardeningResults"
}
]
}}
```

{{ List all the binary hardening analysis results for a firmware.
}}
List all the binary hardening analysis results for a firmware.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,12 @@ Lists cryptographic certificate analysis results found in a firmware.

## EXAMPLES

### Example 1: {{ List all the crypto certificate analysis results for a firmware. }}
### Example 1: List all the crypto certificate analysis results for a firmware.
```powershell
{{ Get-AzFirmwareAnalysisCryptoCertificate -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json }}
Get-AzFirmwareAnalysisCryptoCertificate -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json
```

```output
{{
[
{
"CryptoCertId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
Expand Down Expand Up @@ -71,11 +70,9 @@ Lists cryptographic certificate analysis results found in a firmware.
"Usage": []
}
]
}}
```

{{ List all the crypto certificate analysis results for a firmware.
}}
List all the crypto certificate analysis results for a firmware.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,12 @@ Lists cryptographic key analysis results found in a firmware.

## EXAMPLES

### Example 1: {{ List all the crypto key analysis results for a firmware. }}
### Example 1: List all the crypto key analysis results for a firmware.
```powershell
{{ Get-AzFirmwareAnalysisCryptoKey -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json}}
Get-AzFirmwareAnalysisCryptoKey -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json
```

```output
{{
[
{
"CryptoKeyId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
Expand All @@ -53,11 +52,9 @@ Lists cryptographic key analysis results found in a firmware.
]
}
]
}}
```

{{ List all the crypto key analysis results for a firmware.
}}
List all the crypto key analysis results for a firmware.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,12 @@ Lists CVE analysis results of a firmware.

## EXAMPLES

### Example 1: {{ List all the cve analysis results for a firmware. }}
### Example 1: List all the cve analysis results for a firmware.
```powershell
{{ Get-AzFirmwareAnalysisCve -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json }}
Get-AzFirmwareAnalysisCve -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json
```

```output
{{
[
{
"ComponentId": ,
Expand Down Expand Up @@ -57,11 +56,9 @@ Lists CVE analysis results of a firmware.
"Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cves"
}
]
}}
```

{{ List all the cve analysis results for a firmware.
}}
List all the cve analysis results for a firmware.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,12 @@ Get firmware.

## EXAMPLES

### Example 1: {{ List all the firmwares inside a workspace. }}
### Example 1: List all the firmwares inside a workspace.
```powershell
{{ Get-AzFirmwareAnalysisFirmware -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName }}
Get-AzFirmwareAnalysisFirmware -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName
```

```output
{{
Description :
FileName :
FileSize :
Expand All @@ -67,19 +66,16 @@ SystemDataLastModifiedByType :
Type : microsoft.iotfirmwaredefense/workspaces/firmwares
Vendor :
Version :
}}
```

{{ List all the firmwares inside a workspace.
}}
List all the firmwares inside a workspace.

### Example 2: {{ Get a firmware inside a workspace. }}
### Example 2: Get a firmware inside a workspace.
```powershell
{{ Get-AzFirmwareAnalysisFirmware -Id FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName }}
Get-AzFirmwareAnalysisFirmware -Id FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName
```

```output
{{
Description :
FileName :
FileSize :
Expand All @@ -99,11 +95,9 @@ SystemDataLastModifiedByType :
Type : microsoft.iotfirmwaredefense/workspaces/firmwares
Vendor :
Version :
}}
```

{{ Get a firmware inside a workspace.
}}
Get a firmware inside a workspace.

## PARAMETERS

Expand Down Expand Up @@ -140,7 +134,7 @@ Accept wildcard characters: False
### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
.
```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity
Expand Down Expand Up @@ -188,7 +182,7 @@ Accept wildcard characters: False
### -WorkspaceInputObject
Identity Parameter
To construct, see NOTES section for WORKSPACEINPUTOBJECT properties and create a hash table.
.
```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,12 @@ Lists password hash analysis results of a firmware.

## EXAMPLES

### Example 1: {{ List all the password hash analysis results for a firmware. }}
### Example 1: List all the password hash analysis results for a firmware.
```powershell
{{ Get-AzFirmwareAnalysisPasswordHash -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json }}
Get-AzFirmwareAnalysisPasswordHash -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json
```

```output
{{
[
{
"Algorithm": "",
Expand All @@ -49,11 +48,9 @@ Lists password hash analysis results of a firmware.
"Username": ""
}
]
}}
```

{{ List all the password hash analysis results for a firmware.
}}
List all the password hash analysis results for a firmware.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,12 @@ Lists SBOM analysis results of a firmware.

## EXAMPLES

### Example 1: {{ List all the sbom component analysis results for a firmware. }}
### Example 1: List all the sbom component analysis results for a firmware.
```powershell
{{ Get-AzFirmwareAnalysisSbomComponent -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json}}
Get-AzFirmwareAnalysisSbomComponent -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json
```

```output
{{
[
{
"ComponentId": "",
Expand All @@ -47,11 +46,9 @@ Lists SBOM analysis results of a firmware.
"Version": ""
}
]
}}
```

{{ List all the sbom component analysis results for a firmware.
}}
List all the sbom component analysis results for a firmware.

## PARAMETERS

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

## EXAMPLES

### Example 1: {{ List all the analysis results summary for a firmware by analysis type CVE. }}
### 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 -Name Type
```

```output
{{
Id :
Name :
Property :
Expand All @@ -66,19 +65,17 @@ SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries
}}
```

{{ 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. }}
### 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 -Name Type
```

```output
{{
Id :
Name :
Property :
Expand All @@ -91,11 +88,9 @@ SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries
}}
```

{{ List all the analysis results summary for a firmware by analysis type Firmware.
}}
List all the analysis results summary for a firmware by analysis type Firmware.

## PARAMETERS

Expand Down Expand Up @@ -132,7 +127,7 @@ Accept wildcard characters: False
### -FirmwareInputObject
Identity Parameter
To construct, see NOTES section for FIRMWAREINPUTOBJECT properties and create a hash table.
.
```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity
Expand All @@ -148,7 +143,7 @@ Accept wildcard characters: False
### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
.
```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity
Expand Down Expand Up @@ -211,7 +206,7 @@ Accept wildcard characters: False
### -WorkspaceInputObject
Identity Parameter
To construct, see NOTES section for WORKSPACEINPUTOBJECT properties and create a hash table.
.
```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity
Expand Down
Loading

0 comments on commit 1d7d21c

Please sign in to comment.