Skip to content

Commit

Permalink
Regenerate FirmwareAnalysis
Browse files Browse the repository at this point in the history
  • Loading branch information
msJinLei committed Feb 21, 2024
1 parent 1d7d21c commit 8d5ceee
Show file tree
Hide file tree
Showing 20 changed files with 36 additions and 311 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-AzFirmwareAnalysisFirmwareDownloadUrl', '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-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl', 'New-AzFirmwareAnalysisWorkspace', 'New-AzFirmwareAnalysisWorkspaceUploadUrl', 'Remove-AzFirmwareAnalysisFirmware', 'Remove-AzFirmwareAnalysisWorkspace', 'Update-AzFirmwareAnalysisFirmware', 'Update-AzFirmwareAnalysisWorkspace'
PrivateData = @{
PSData = @{
Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'FirmwareAnalysis'
Expand Down
4 changes: 4 additions & 0 deletions src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
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 All @@ -28,6 +31,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
require:
# readme.azure.noprofile.md is the common configuration file
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Custom
This directory contains custom implementation for non-generated cmdlets for the `Az.FirmwareAnalysis` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.FirmwareAnalysis.custom.psm1`. This file should not be modified.
This directory contains custom implementation for non-generated cmdlets for the `Az.FirmwareAnalysis` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.FirmwareAnalysis.custom.psm1`. This file should not be modified.

## Info
- Modifiable: yes
Expand All @@ -15,10 +15,10 @@ For C# cmdlets, they are compiled with the rest of the generated low-level cmdle
For script cmdlets, these are loaded via the `Az.FirmwareAnalysis.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build.

## Purpose
This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder.
This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder.

## Usage
The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `..\exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
- Break
- DefaultProfile
- HttpPipelineAppend
Expand All @@ -36,6 +36,6 @@ For processing the cmdlets, we've created some additional attributes:
- `Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.DoNotExportAttribute`
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.FirmwareAnalysis`.
- `Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.InternalExportAttribute`
- Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.FirmwareAnalysis`. For more information, see [README.md](../internal/README.md) in the `../internal` folder.
- Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.FirmwareAnalysis`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder.
- `Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.ProfileAttribute`
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,6 @@ 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 @@ -134,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 @@ -182,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 @@ -12,13 +12,7 @@ Get an analysis result summary of a firmware by name.

## SYNTAX

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

### Get
### Get (Default)
```
Get-AzFirmwareAnalysisSummary -FirmwareId <String> -Name <String> -ResourceGroupName <String>
-WorkspaceName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]
Expand Down Expand Up @@ -115,7 +109,7 @@ The id of the firmware.
```yaml
Type: System.String
Parameter Sets: Get, GetViaIdentityWorkspace, List
Parameter Sets: Get, GetViaIdentityWorkspace
Aliases:

Required: True
Expand All @@ -127,7 +121,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 @@ -143,7 +137,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 @@ -178,7 +172,7 @@ The name is case insensitive.
```yaml
Type: System.String
Parameter Sets: Get, List
Parameter Sets: Get
Aliases:

Required: True
Expand All @@ -194,7 +188,7 @@ The value must be an UUID.
```yaml
Type: System.String[]
Parameter Sets: Get, List
Parameter Sets: Get
Aliases:

Required: False
Expand All @@ -206,7 +200,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 All @@ -225,7 +219,7 @@ The name of the firmware analysis workspace.
```yaml
Type: System.String
Parameter Sets: Get, List
Parameter Sets: Get
Aliases:

Required: True
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,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
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ Accept wildcard characters: False
### -StatusMessage
A list of errors or other messages generated during firmware analysis
.
To construct, see NOTES section for STATUSMESSAGE properties and create a hash table.
```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IStatusMessage[]
Expand Down

This file was deleted.

Loading

0 comments on commit 8d5ceee

Please sign in to comment.