From fbc8d16be61dfe13d23a492547935af177981109 Mon Sep 17 00:00:00 2001 From: Lei Jin Date: Wed, 21 Feb 2024 22:15:32 +0800 Subject: [PATCH] Regenerate FirmwareAnalysis --- .../Az.FirmwareAnalysis.psd1 | 2 +- .../FirmwareAnalysis.Autorest/README.md | 4 + .../custom/README.md | 8 +- .../docs/Az.FirmwareAnalysis.md | 3 - .../docs/Get-AzFirmwareAnalysisFirmware.md | 4 +- .../docs/Get-AzFirmwareAnalysisSummary.md | 22 +- .../docs/Get-AzFirmwareAnalysisWorkspace.md | 2 +- .../docs/New-AzFirmwareAnalysisFirmware.md | 2 +- ...w-AzFirmwareAnalysisFirmwareDownloadUrl.md | 219 ------------------ ...reAnalysisFirmwareFilesystemDownloadUrl.md | 4 +- ...ew-AzFirmwareAnalysisWorkspaceUploadUrl.md | 4 +- .../FirmwareAnalysis.Autorest/docs/README.md | 4 +- .../docs/Remove-AzFirmwareAnalysisFirmware.md | 4 +- .../Remove-AzFirmwareAnalysisWorkspace.md | 2 +- .../docs/Update-AzFirmwareAnalysisFirmware.md | 6 +- .../Update-AzFirmwareAnalysisWorkspace.md | 2 +- ...w-AzFirmwareAnalysisFirmwareDownloadUrl.md | 22 -- .../resources/README.md | 2 +- ...mwareAnalysisFirmwareDownloadUrl.Tests.ps1 | 29 --- .../FirmwareAnalysis.Autorest/test/README.md | 2 +- 20 files changed, 36 insertions(+), 311 deletions(-) delete mode 100644 src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareDownloadUrl.md delete mode 100644 src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmwareDownloadUrl.md delete mode 100644 src/FirmwareAnalysis/FirmwareAnalysis.Autorest/test/New-AzFirmwareAnalysisFirmwareDownloadUrl.Tests.ps1 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/Az.FirmwareAnalysis.psd1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/Az.FirmwareAnalysis.psd1 index ab7f0cdf3372..cc41ccd39025 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/Az.FirmwareAnalysis.psd1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/Az.FirmwareAnalysis.psd1 @@ -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' diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md index e418df514972..58a865cdca11 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md @@ -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 @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/custom/README.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/custom/README.md index 6c08a3e38188..253374b744e9 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/custom/README.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/custom/README.md @@ -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 @@ -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 @@ -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. \ No newline at end of file diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Az.FirmwareAnalysis.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Az.FirmwareAnalysis.md index 4125421c7822..130d5c8ef9f0 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Az.FirmwareAnalysis.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Az.FirmwareAnalysis.md @@ -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. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisFirmware.md index 9a457a8f8660..2b97bb274ab6 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisFirmware.md @@ -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 @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSummary.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSummary.md index c3d2d8bb50c3..20c18fc36971 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSummary.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSummary.md @@ -12,13 +12,7 @@ Get an analysis result summary of a firmware by name. ## SYNTAX -### List (Default) -``` -Get-AzFirmwareAnalysisSummary -FirmwareId -ResourceGroupName -WorkspaceName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get +### Get (Default) ``` Get-AzFirmwareAnalysisSummary -FirmwareId -Name -ResourceGroupName -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] [] @@ -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 @@ -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 @@ -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 @@ -178,7 +172,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: Get Aliases: Required: True @@ -194,7 +188,7 @@ The value must be an UUID. ```yaml Type: System.String[] -Parameter Sets: Get, List +Parameter Sets: Get Aliases: Required: False @@ -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 @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisWorkspace.md index 97f437f8ad02..95804f5d519c 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisWorkspace.md @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmware.md index 61f2870416f6..60d09b87b3d7 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmware.md @@ -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[] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareDownloadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareDownloadUrl.md deleted file mode 100644 index 7b156b64f347..000000000000 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareDownloadUrl.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: -Module Name: Az.FirmwareAnalysis -online version: https://learn.microsoft.com/powershell/module/az.firmwareanalysis/new-azfirmwareanalysisfirmwaredownloadurl -schema: 2.0.0 ---- - -# New-AzFirmwareAnalysisFirmwareDownloadUrl - -## SYNOPSIS -The operation to a url for file download. - -## SYNTAX - -### Generate (Default) -``` -New-AzFirmwareAnalysisFirmwareDownloadUrl -FirmwareId -ResourceGroupName - -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -### GenerateViaIdentity -``` -New-AzFirmwareAnalysisFirmwareDownloadUrl -InputObject - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### GenerateViaIdentityWorkspace -``` -New-AzFirmwareAnalysisFirmwareDownloadUrl -FirmwareId - -WorkspaceInputObject [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -The operation to a url for file download. - -## EXAMPLES - -### Example 1: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirmwareId -The id of the firmware. - -```yaml -Type: System.String -Parameter Sets: Generate, GenerateViaIdentityWorkspace -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity -Parameter Sets: GenerateViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Generate -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. -The value must be an UUID. - -```yaml -Type: System.String -Parameter Sets: Generate -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceInputObject -Identity Parameter -. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity -Parameter Sets: GenerateViaIdentityWorkspace -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorkspaceName -The name of the firmware analysis workspace. - -```yaml -Type: System.String -Parameter Sets: Generate -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IUrlToken - -## NOTES - -## RELATED LINKS - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md index 705039f32ced..3f8f3259d113 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md @@ -79,7 +79,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 @@ -127,7 +127,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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspaceUploadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspaceUploadUrl.md index e59e475d4137..abedca0cda62 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspaceUploadUrl.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspaceUploadUrl.md @@ -106,7 +106,7 @@ Accept wildcard characters: False ### -GenerateUploadUrl Properties for generating an upload URL -. +To construct, see NOTES section for GENERATEUPLOADURL properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IGenerateUploadUrlRequest @@ -122,7 +122,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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/README.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/README.md index fcc6abe7b102..4ed76fbe294c 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/README.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/README.md @@ -1,5 +1,5 @@ # Docs -This directory contains the documentation of the cmdlets for the `Az.FirmwareAnalysis` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `../examples` folder. +This directory contains the documentation of the cmdlets for the `Az.FirmwareAnalysis` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `..\examples` folder. ## Info - Modifiable: no @@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.FirmwareAna - Packaged: yes ## Details -The process of documentation generation loads `Az.FirmwareAnalysis` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file +The process of documentation generation loads `Az.FirmwareAnalysis` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder. \ No newline at end of file diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisFirmware.md index 9c367e9ea9d5..4495d71e365d 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisFirmware.md @@ -77,7 +77,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 @@ -140,7 +140,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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisWorkspace.md index 67c8ed307cc9..a5f09309519c 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisWorkspace.md @@ -56,7 +56,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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisFirmware.md index 4b97a7cb9304..514fd47e7a21 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisFirmware.md @@ -150,7 +150,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 @@ -212,7 +212,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[] @@ -274,7 +274,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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisWorkspace.md index 3ac4c0e05e99..d47225b4e97c 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisWorkspace.md @@ -72,7 +72,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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmwareDownloadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmwareDownloadUrl.md deleted file mode 100644 index 0371f56c36d2..000000000000 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmwareDownloadUrl.md +++ /dev/null @@ -1,22 +0,0 @@ -### Example 1: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/resources/README.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/resources/README.md index 736492341e3d..937f07f8fec2 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/resources/README.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/resources/README.md @@ -1,5 +1,5 @@ # Resources -This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `../custom` folder. +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder. ## Info - Modifiable: yes diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/test/New-AzFirmwareAnalysisFirmwareDownloadUrl.Tests.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/test/New-AzFirmwareAnalysisFirmwareDownloadUrl.Tests.ps1 deleted file mode 100644 index 1ca2ba6e3d43..000000000000 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/test/New-AzFirmwareAnalysisFirmwareDownloadUrl.Tests.ps1 +++ /dev/null @@ -1,29 +0,0 @@ -if(($null -eq $TestName) -or ($TestName -contains 'New-AzFirmwareAnalysisFirmwareDownloadUrl')) -{ - $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' - if (-Not (Test-Path -Path $loadEnvPath)) { - $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' - } - . ($loadEnvPath) - $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzFirmwareAnalysisFirmwareDownloadUrl.Recording.json' - $currentPath = $PSScriptRoot - while(-not $mockingPath) { - $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File - $currentPath = Split-Path -Path $currentPath -Parent - } - . ($mockingPath | Select-Object -First 1).FullName -} - -Describe 'New-AzFirmwareAnalysisFirmwareDownloadUrl' { - It 'Generate' -skip { - { throw [System.NotImplementedException] } | Should -Not -Throw - } - - It 'GenerateViaIdentityWorkspace' -skip { - { throw [System.NotImplementedException] } | Should -Not -Throw - } - - It 'GenerateViaIdentity' -skip { - { throw [System.NotImplementedException] } | Should -Not -Throw - } -} diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/test/README.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/test/README.md index 1969200c6a09..7c752b4c8c43 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/test/README.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/test/README.md @@ -1,5 +1,5 @@ # Test -This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `../custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. +This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `..\custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. ## Info - Modifiable: yes