Skip to content

Commit 1d7d21c

Browse files
Fix documentation for firmwareanalysis ps
1 parent a2140dd commit 1d7d21c

File tree

40 files changed

+430
-245
lines changed

40 files changed

+430
-245
lines changed

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/Az.FirmwareAnalysis.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
DotNetFrameworkVersion = '4.7.2'
1212
RequiredAssemblies = './bin/Az.FirmwareAnalysis.private.dll'
1313
FormatsToProcess = './Az.FirmwareAnalysis.format.ps1xml'
14-
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'
14+
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'
1515
PrivateData = @{
1616
PSData = @{
1717
Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'FirmwareAnalysis'

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
This directory contains the PowerShell module for the FirmwareAnalysis service.
44

55
---
6-
## Status
7-
[![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/)
8-
96
## Info
107
- Modifiable: yes
118
- Generated: all
@@ -89,6 +86,17 @@ directive:
8986
verb: Set
9087
remove: true
9188

89+
- where:
90+
verb: New
91+
subject: FirmwareDownloadUrl
92+
remove: true
93+
94+
- where:
95+
verb: Get
96+
subject: Summary
97+
variant: List
98+
remove: true
99+
92100
- where:
93101
parameter-name: Id
94102
verb: New

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Az.FirmwareAnalysis.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ Get firmware analysis workspace.
4141
### [New-AzFirmwareAnalysisFirmware](New-AzFirmwareAnalysisFirmware.md)
4242
The operation to create a firmware.
4343

44+
### [New-AzFirmwareAnalysisFirmwareDownloadUrl](New-AzFirmwareAnalysisFirmwareDownloadUrl.md)
45+
The operation to a url for file download.
46+
4447
### [New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl](New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md)
4548
The operation to a url for tar file download.
4649

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisBinaryHardening.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@ Lists binary hardening analysis results of a firmware.
2222

2323
## EXAMPLES
2424

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

3030
```output
31-
{{
3231
[
3332
{
3433
"Architecture": "",
@@ -53,11 +52,9 @@ Lists binary hardening analysis results of a firmware.
5352
"Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/binaryHardeningResults"
5453
}
5554
]
56-
}}
5755
```
5856

59-
{{ List all the binary hardening analysis results for a firmware.
60-
}}
57+
List all the binary hardening analysis results for a firmware.
6158

6259
## PARAMETERS
6360

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoCertificate.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@ Lists cryptographic certificate analysis results found in a firmware.
2222

2323
## EXAMPLES
2424

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

3030
```output
31-
{{
3231
[
3332
{
3433
"CryptoCertId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
@@ -71,11 +70,9 @@ Lists cryptographic certificate analysis results found in a firmware.
7170
"Usage": []
7271
}
7372
]
74-
}}
7573
```
7674

77-
{{ List all the crypto certificate analysis results for a firmware.
78-
}}
75+
List all the crypto certificate analysis results for a firmware.
7976

8077
## PARAMETERS
8178

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoKey.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@ Lists cryptographic key analysis results found in a firmware.
2222

2323
## EXAMPLES
2424

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

3030
```output
31-
{{
3231
[
3332
{
3433
"CryptoKeyId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
@@ -53,11 +52,9 @@ Lists cryptographic key analysis results found in a firmware.
5352
]
5453
}
5554
]
56-
}}
5755
```
5856

59-
{{ List all the crypto key analysis results for a firmware.
60-
}}
57+
List all the crypto key analysis results for a firmware.
6158

6259
## PARAMETERS
6360

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCve.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@ Lists CVE analysis results of a firmware.
2222

2323
## EXAMPLES
2424

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

3030
```output
31-
{{
3231
[
3332
{
3433
"ComponentId": ,
@@ -57,11 +56,9 @@ Lists CVE analysis results of a firmware.
5756
"Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cves"
5857
}
5958
]
60-
}}
6159
```
6260

63-
{{ List all the cve analysis results for a firmware.
64-
}}
61+
List all the cve analysis results for a firmware.
6562

6663
## PARAMETERS
6764

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisFirmware.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,12 @@ Get firmware.
4141

4242
## EXAMPLES
4343

44-
### Example 1: {{ List all the firmwares inside a workspace. }}
44+
### Example 1: List all the firmwares inside a workspace.
4545
```powershell
46-
{{ Get-AzFirmwareAnalysisFirmware -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName }}
46+
Get-AzFirmwareAnalysisFirmware -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName
4747
```
4848

4949
```output
50-
{{
5150
Description :
5251
FileName :
5352
FileSize :
@@ -67,19 +66,16 @@ SystemDataLastModifiedByType :
6766
Type : microsoft.iotfirmwaredefense/workspaces/firmwares
6867
Vendor :
6968
Version :
70-
}}
7169
```
7270

73-
{{ List all the firmwares inside a workspace.
74-
}}
71+
List all the firmwares inside a workspace.
7572

76-
### Example 2: {{ Get a firmware inside a workspace. }}
73+
### Example 2: Get a firmware inside a workspace.
7774
```powershell
78-
{{ Get-AzFirmwareAnalysisFirmware -Id FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName }}
75+
Get-AzFirmwareAnalysisFirmware -Id FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName
7976
```
8077

8178
```output
82-
{{
8379
Description :
8480
FileName :
8581
FileSize :
@@ -99,11 +95,9 @@ SystemDataLastModifiedByType :
9995
Type : microsoft.iotfirmwaredefense/workspaces/firmwares
10096
Vendor :
10197
Version :
102-
}}
10398
```
10499

105-
{{ Get a firmware inside a workspace.
106-
}}
100+
Get a firmware inside a workspace.
107101

108102
## PARAMETERS
109103

@@ -140,7 +134,7 @@ Accept wildcard characters: False
140134
141135
### -InputObject
142136
Identity Parameter
143-
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
137+
.
144138
145139
```yaml
146140
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity
@@ -188,7 +182,7 @@ Accept wildcard characters: False
188182
189183
### -WorkspaceInputObject
190184
Identity Parameter
191-
To construct, see NOTES section for WORKSPACEINPUTOBJECT properties and create a hash table.
185+
.
192186
193187
```yaml
194188
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisPasswordHash.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@ Lists password hash analysis results of a firmware.
2222

2323
## EXAMPLES
2424

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

3030
```output
31-
{{
3231
[
3332
{
3433
"Algorithm": "",
@@ -49,11 +48,9 @@ Lists password hash analysis results of a firmware.
4948
"Username": ""
5049
}
5150
]
52-
}}
5351
```
5452

55-
{{ List all the password hash analysis results for a firmware.
56-
}}
53+
List all the password hash analysis results for a firmware.
5754

5855
## PARAMETERS
5956

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSbomComponent.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@ Lists SBOM analysis results of a firmware.
2222

2323
## EXAMPLES
2424

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

3030
```output
31-
{{
3231
[
3332
{
3433
"ComponentId": "",
@@ -47,11 +46,9 @@ Lists SBOM analysis results of a firmware.
4746
"Version": ""
4847
}
4948
]
50-
}}
5149
```
5250

53-
{{ List all the sbom component analysis results for a firmware.
54-
}}
51+
List all the sbom component analysis results for a firmware.
5552

5653
## PARAMETERS
5754

src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSummary.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,12 @@ Get an analysis result summary of a firmware by name.
4747

4848
## EXAMPLES
4949

50-
### Example 1: {{ List all the analysis results summary for a firmware by analysis type CVE. }}
50+
### Example 1: List all the analysis results summary for a firmware by analysis type CVE.
5151
```powershell
52-
{{ Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Name Type }}
52+
Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Name Type
5353
```
5454

5555
```output
56-
{{
5756
Id :
5857
Name :
5958
Property :
@@ -66,19 +65,17 @@ SystemDataLastModifiedAt :
6665
SystemDataLastModifiedBy :
6766
SystemDataLastModifiedByType :
6867
Type : Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries
69-
}}
7068
```
7169

7270
{{ List all the analysis results summary for a firmware by analysis type CVE.
7371
}}
7472

75-
### Example 2: {{ List all the analysis results summary for a firmware by analysis type Firmware. }}
73+
### Example 2: List all the analysis results summary for a firmware by analysis type Firmware.
7674
```powershell
77-
{{ Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Name Type }}
75+
Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Name Type
7876
```
7977

8078
```output
81-
{{
8279
Id :
8380
Name :
8481
Property :
@@ -91,11 +88,9 @@ SystemDataLastModifiedAt :
9188
SystemDataLastModifiedBy :
9289
SystemDataLastModifiedByType :
9390
Type : Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries
94-
}}
9591
```
9692

97-
{{ List all the analysis results summary for a firmware by analysis type Firmware.
98-
}}
93+
List all the analysis results summary for a firmware by analysis type Firmware.
9994

10095
## PARAMETERS
10196

@@ -132,7 +127,7 @@ Accept wildcard characters: False
132127
133128
### -FirmwareInputObject
134129
Identity Parameter
135-
To construct, see NOTES section for FIRMWAREINPUTOBJECT properties and create a hash table.
130+
.
136131
137132
```yaml
138133
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity
@@ -148,7 +143,7 @@ Accept wildcard characters: False
148143
149144
### -InputObject
150145
Identity Parameter
151-
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
146+
.
152147
153148
```yaml
154149
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity
@@ -211,7 +206,7 @@ Accept wildcard characters: False
211206
212207
### -WorkspaceInputObject
213208
Identity Parameter
214-
To construct, see NOTES section for WORKSPACEINPUTOBJECT properties and create a hash table.
209+
.
215210
216211
```yaml
217212
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity

0 commit comments

Comments
 (0)