From 67d6122d71ccaf6d760cd2fb3a36aba7073c8282 Mon Sep 17 00:00:00 2001 From: kalpeshbhatia000 <108032504+kalpeshbhatia000@users.noreply.github.com> Date: Wed, 21 Feb 2024 20:37:33 -0800 Subject: [PATCH] Feature firmwareanalysis fix (#24188) * Fix documentation for firmwareanalysis ps * Regenerate FirmwareAnalysis * remove commands and some variants * update doc --------- Co-authored-by: Lei Jin --- .../FirmwareAnalysis.Autorest/README.md | 13 +++++- .../custom/README.md | 8 ++-- .../Get-AzFirmwareAnalysisBinaryHardening.md | 9 ++--- ...Get-AzFirmwareAnalysisCryptoCertificate.md | 9 ++--- .../docs/Get-AzFirmwareAnalysisCryptoKey.md | 9 ++--- .../docs/Get-AzFirmwareAnalysisCve.md | 9 ++--- .../docs/Get-AzFirmwareAnalysisFirmware.md | 22 ++++------ .../Get-AzFirmwareAnalysisPasswordHash.md | 9 ++--- .../Get-AzFirmwareAnalysisSbomComponent.md | 9 ++--- .../docs/Get-AzFirmwareAnalysisSummary.md | 40 +++++++------------ .../docs/Get-AzFirmwareAnalysisWorkspace.md | 20 ++++------ .../docs/New-AzFirmwareAnalysisFirmware.md | 21 ++++------ ...reAnalysisFirmwareFilesystemDownloadUrl.md | 11 +++-- .../docs/New-AzFirmwareAnalysisWorkspace.md | 9 ++--- ...ew-AzFirmwareAnalysisWorkspaceUploadUrl.md | 13 +++--- .../FirmwareAnalysis.Autorest/docs/README.md | 4 +- .../docs/Remove-AzFirmwareAnalysisFirmware.md | 11 +++-- .../Remove-AzFirmwareAnalysisWorkspace.md | 9 ++--- .../docs/Update-AzFirmwareAnalysisFirmware.md | 16 +++----- .../Update-AzFirmwareAnalysisWorkspace.md | 11 ++--- .../Get-AzFirmwareAnalysisBinaryHardening.md | 8 ++-- ...Get-AzFirmwareAnalysisCryptoCertificate.md | 8 ++-- .../Get-AzFirmwareAnalysisCryptoKey.md | 8 ++-- .../examples/Get-AzFirmwareAnalysisCve.md | 8 ++-- .../Get-AzFirmwareAnalysisFirmware.md | 16 +++----- .../Get-AzFirmwareAnalysisPasswordHash.md | 8 ++-- .../Get-AzFirmwareAnalysisSbomComponent.md | 8 ++-- .../examples/Get-AzFirmwareAnalysisSummary.md | 16 +++----- .../Get-AzFirmwareAnalysisWorkspace.md | 16 +++----- .../New-AzFirmwareAnalysisFirmware.md | 17 +++----- ...reAnalysisFirmwareFilesystemDownloadUrl.md | 6 +-- .../New-AzFirmwareAnalysisWorkspace.md | 8 ++-- ...ew-AzFirmwareAnalysisWorkspaceUploadUrl.md | 8 ++-- .../Remove-AzFirmwareAnalysisFirmware.md | 6 +-- .../Remove-AzFirmwareAnalysisWorkspace.md | 6 +-- .../Update-AzFirmwareAnalysisFirmware.md | 9 ++--- .../Update-AzFirmwareAnalysisWorkspace.md | 8 ++-- .../resources/README.md | 2 +- .../FirmwareAnalysis.Autorest/test/README.md | 2 +- 39 files changed, 169 insertions(+), 261 deletions(-) diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md index 96abebeac2a8..f145ebe69c58 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/README.md @@ -89,10 +89,21 @@ 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 - subject: AzFirmwareAnalysisFirmware + subject: Firmware set: default: name: Id 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/Get-AzFirmwareAnalysisBinaryHardening.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisBinaryHardening.md index 0061d034142c..52e0f009c09c 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisBinaryHardening.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisBinaryHardening.md @@ -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": "", @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoCertificate.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoCertificate.md index 023d53d444cb..851b713c8185 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoCertificate.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoCertificate.md @@ -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", @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoKey.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoKey.md index f5841b4a2937..d3496e2ea170 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoKey.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCryptoKey.md @@ -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", @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCve.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCve.md index 5d10721499b4..fc3e0786d6e1 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCve.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisCve.md @@ -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": , @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisFirmware.md index 72cb2f99c8db..9a457a8f8660 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisFirmware.md @@ -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 : @@ -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 : @@ -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 @@ -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 @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisPasswordHash.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisPasswordHash.md index a24169d79ddf..e21929ee35cf 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisPasswordHash.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisPasswordHash.md @@ -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": "", @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSbomComponent.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSbomComponent.md index 7dc85fc208fc..33ea06736403 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSbomComponent.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSbomComponent.md @@ -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": "", @@ -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 diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSummary.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisSummary.md index ba08692f040b..5aac73c0dc89 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 ] [] @@ -47,13 +41,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 : @@ -66,19 +59,16 @@ SystemDataLastModifiedAt : SystemDataLastModifiedBy : SystemDataLastModifiedByType : Type : Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries - }} ``` -{{ List all the analysis results summary for a firmware by analysis type CVE. -}} +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 : @@ -91,11 +81,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 @@ -120,7 +108,7 @@ The id of the firmware. ```yaml Type: System.String -Parameter Sets: Get, GetViaIdentityWorkspace, List +Parameter Sets: Get, GetViaIdentityWorkspace Aliases: Required: True @@ -132,7 +120,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 @@ -148,7 +136,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 @@ -183,7 +171,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: Get Aliases: Required: True @@ -199,7 +187,7 @@ The value must be an UUID. ```yaml Type: System.String[] -Parameter Sets: Get, List +Parameter Sets: Get Aliases: Required: False @@ -211,7 +199,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 @@ -230,7 +218,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 b5fb35b7d008..97f437f8ad02 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Get-AzFirmwareAnalysisWorkspace.md @@ -40,13 +40,12 @@ Get firmware analysis workspace. ## EXAMPLES -### Example 1: {{ List all firmware analysis workspaces in the specified subscription. }} +### Example 1: List all firmware analysis workspaces in the specified subscription. ```powershell -{{ Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName }} +Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName ``` ```output -{{ Id : Location : Name : @@ -60,19 +59,16 @@ SystemDataLastModifiedBy : SystemDataLastModifiedByType : Tag : {} Type : microsoft.iotfirmwaredefense/workspaces - }} ``` -{{ List all firmware analysis workspaces in the specified subscription. -}} +List all firmware analysis workspaces in the specified subscription. -### Example 2: {{ Get firmware analysis workspace from the specified subscription. }} +### Example 2: Get firmware analysis workspace from the specified subscription. ```powershell -{{ Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName }} +Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName ``` ```output -{{ Id : Location : Name : @@ -86,11 +82,9 @@ SystemDataLastModifiedBy : SystemDataLastModifiedByType : Tag : {} Type : microsoft.iotfirmwaredefense/workspaces -}} ``` -{{ Get firmware analysis workspace from the specified subscription. -}} +Get firmware analysis workspace from the specified subscription. ## PARAMETERS @@ -112,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 a4a784a2525f..66044be3a3ea 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmware.md @@ -24,13 +24,12 @@ The operation to create a firmware. ## EXAMPLES -### Example 1: {{ Create a new firmware using new guid. }} +### Example 1: Create a new firmware using new guid. ```powershell -{{ New-AzFirmwareAnalysisFirmware -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version }} +New-AzFirmwareAnalysisFirmware -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version ``` ```output -{{ Description : description FileName : FileName FileSize : 1 @@ -50,20 +49,16 @@ SystemDataLastModifiedByType : Type : microsoft.iotfirmwaredefense/workspaces/firmwares Vendor : vendor Version : version - }} ``` -{{ Create a new firmware using new guid. -}} +Create a new firmware using new guid. -### Example 2: {{ Create a new firmware using a user specified firmwareId. }} +### Example 2: Create a new firmware using a user specified firmwareId. ```powershell -{{ New-AzFirmwareAnalysisFirmware -Id firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version -}} +New-AzFirmwareAnalysisFirmware -Id firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version ``` ```output -{{ Description : description FileName : FileName FileSize : 1 @@ -83,11 +78,9 @@ SystemDataLastModifiedByType : Type : microsoft.iotfirmwaredefense/workspaces/firmwares Vendor : vendor Version : version - }} ``` -{{ Create a new firmware using a user specified firmwareId. -}} +Create a new firmware using a user specified firmwareId. ## PARAMETERS @@ -215,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-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md index 1ef08f835c56..705039f32ced 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md @@ -37,13 +37,12 @@ The operation to a url for tar file download. ## EXAMPLES -### Example 1: {{ Get a url for tar file download. }} +### Example 1: Get a url for tar file download. ```powershell -{{ New-AzFirmwareAnalysisFirmwareDownloadUrl -FirmwareId firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName }} +New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl -FirmwareId firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName ``` -{{ Get a url for tar file download. -}} +Get a url for tar file download. ## PARAMETERS @@ -80,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 @@ -128,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-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspace.md index b05f13558004..7b4283928dda 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspace.md @@ -23,13 +23,12 @@ The operation to Create a firmware analysis workspace. ## EXAMPLES -### Example 1: {{ Create a new firmware analysis workspace. }} +### Example 1: Create a new firmware analysis workspace. ```powershell -{{ New-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name name -Location location }} +New-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name name -Location location ``` ```output -{{ Id : Location : Name : @@ -43,11 +42,9 @@ SystemDataLastModifiedBy : SystemDataLastModifiedByType : Tag : {} Type : microsoft.iotfirmwaredefense/workspaces -}} ``` -{{ Create a new firmware analysis workspace. -}} +Create a new firmware analysis workspace. ## PARAMETERS diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspaceUploadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspaceUploadUrl.md index b7459bfc53e1..e59e475d4137 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspaceUploadUrl.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/New-AzFirmwareAnalysisWorkspaceUploadUrl.md @@ -58,21 +58,18 @@ The operation to get a url for file upload. ## EXAMPLES -### Example 1: {{ Create a url for file upload. }} +### Example 1: Create a url for file upload. ```powershell -{{ New-AzFirmwareAnalysisWorkspaceUploadUrl -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -FirmwareId firmwareId }} +New-AzFirmwareAnalysisWorkspaceUploadUrl -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -FirmwareId firmwareId ``` ```output -{{ Url --- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - }} ``` -{{ Create a url for file upload. -}} +Create a url for file upload. ## PARAMETERS @@ -109,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 @@ -125,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 732a39e28827..9c367e9ea9d5 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisFirmware.md @@ -35,13 +35,12 @@ The operation to delete a firmware. ## EXAMPLES -### Example 1: {{ Delete a firmware analysis workspace. }} +### Example 1: Delete a firmware analysis workspace. ```powershell -{{ Remove-AzFirmwareAnalysisFirmware -Id firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName }} +Remove-AzFirmwareAnalysisFirmware -Id firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName ``` -{{ Delete a firmware analysis workspace. -}} +Delete a firmware analysis workspace. ## PARAMETERS @@ -78,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 @@ -141,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 f3e6c34976e1..67c8ed307cc9 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Remove-AzFirmwareAnalysisWorkspace.md @@ -29,13 +29,12 @@ The operation to delete a firmware analysis workspace. ## EXAMPLES -### Example 1: {{ Delete a firmware analysis workspace. }} +### Example 1: Delete a firmware analysis workspace. ```powershell -{{ Remove-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName }} +Remove-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName ``` -{{ Delete a firmware analysis workspace. -}} +Delete a firmware analysis workspace. ## PARAMETERS @@ -57,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 021b7ea5b3b2..4b97a7cb9304 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisFirmware.md @@ -41,14 +41,12 @@ The operation to update firmware. ## EXAMPLES -### Example 1: {{ Update a firmware. }} +### Example 1: Update a firmware. ```powershell -{{ Update-AzFirmwareAnalysisFirmware -FirmwareId firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version -}} +Update-AzFirmwareAnalysisFirmware -FirmwareId firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version ``` ```output -{{ Description : description FileName : FileName FileSize : 1 @@ -68,11 +66,9 @@ SystemDataLastModifiedByType : Type : microsoft.iotfirmwaredefense/workspaces/firmwares Vendor : vendor Version : version - }} ``` -{{ Update a firmware. -}} +Update a firmware. ## PARAMETERS @@ -154,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 @@ -216,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[] @@ -278,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 f087f513f751..3ac4c0e05e99 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/docs/Update-AzFirmwareAnalysisWorkspace.md @@ -29,13 +29,12 @@ The operation to update a firmware analysis workspaces. ## EXAMPLES -### Example 1: {{ Update a firmware analysis workspace. }} +### Example 1: Update a firmware analysis workspace. ```powershell -{{ Update-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName }} +Update-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName ``` ```output -{{ Id : Location : Name : @@ -49,11 +48,9 @@ SystemDataLastModifiedBy : SystemDataLastModifiedByType : Tag : {} Type : microsoft.iotfirmwaredefense/workspaces - }} ``` -{{ Update a firmware analysis workspace. -}} +Update a firmware analysis workspace. ## PARAMETERS @@ -75,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/Get-AzFirmwareAnalysisBinaryHardening.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisBinaryHardening.md index 72e245604eee..fafe71d5eb58 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisBinaryHardening.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisBinaryHardening.md @@ -1,10 +1,9 @@ -### 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": "", @@ -29,8 +28,7 @@ "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. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCryptoCertificate.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCryptoCertificate.md index 9eaa0d31885c..1f6485240bc3 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCryptoCertificate.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCryptoCertificate.md @@ -1,10 +1,9 @@ -### 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", @@ -47,8 +46,7 @@ "Usage": [] } ] - }} ``` -{{ List all the crypto certificate analysis results for a firmware. }} +List all the crypto certificate analysis results for a firmware. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCryptoKey.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCryptoKey.md index 821ff218e5c3..7388c6e466cb 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCryptoKey.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCryptoKey.md @@ -1,10 +1,9 @@ -### 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", @@ -29,8 +28,7 @@ ] } ] - }} ``` -{{ List all the crypto key analysis results for a firmware. }} +List all the crypto key analysis results for a firmware. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCve.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCve.md index ef5532ca94c4..fb7f7a8efa57 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCve.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisCve.md @@ -1,10 +1,9 @@ -### 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": , @@ -33,8 +32,7 @@ "Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cves" } ] -}} ``` -{{ List all the cve analysis results for a firmware. }} +List all the cve analysis results for a firmware. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisFirmware.md index cf5aedffd65a..7156561b0cc9 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisFirmware.md @@ -1,10 +1,9 @@ -### 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 : @@ -24,18 +23,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 : @@ -55,8 +52,7 @@ SystemDataLastModifiedByType : Type : microsoft.iotfirmwaredefense/workspaces/firmwares Vendor : Version : - }} ``` -{{ Get a firmware inside a workspace. }} + Get a firmware inside a workspace. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisPasswordHash.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisPasswordHash.md index bb37189d9517..fe5d0233ee00 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisPasswordHash.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisPasswordHash.md @@ -1,10 +1,9 @@ -### 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": "", @@ -25,8 +24,7 @@ "Username": "" } ] - }} ``` -{{ List all the password hash analysis results for a firmware. }} + List all the password hash analysis results for a firmware. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisSbomComponent.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisSbomComponent.md index 8fa089cc431a..605a4a6e7687 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisSbomComponent.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisSbomComponent.md @@ -1,10 +1,9 @@ -### 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": "", @@ -23,8 +22,7 @@ "Version": "" } ] -}} ``` -{{ List all the sbom component analysis results for a firmware. }} +List all the sbom component analysis results for a firmware. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisSummary.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisSummary.md index 599911c852c6..52239d026b06 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisSummary.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisSummary.md @@ -1,10 +1,9 @@ -### 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 : @@ -17,18 +16,16 @@ SystemDataLastModifiedAt : SystemDataLastModifiedBy : SystemDataLastModifiedByType : Type : Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries - }} ``` -{{ List all the analysis results summary for a firmware by analysis type CVE. }} +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 : @@ -41,8 +38,7 @@ 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. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisWorkspace.md index 7be9dbf673fb..a731cf004e7f 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Get-AzFirmwareAnalysisWorkspace.md @@ -1,10 +1,9 @@ -### Example 1: {{ List all firmware analysis workspaces in the specified subscription. }} +### Example 1: List all firmware analysis workspaces in the specified subscription. ```powershell -{{ Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName }} +Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName ``` ```output -{{ Id : Location : Name : @@ -18,18 +17,16 @@ SystemDataLastModifiedBy : SystemDataLastModifiedByType : Tag : {} Type : microsoft.iotfirmwaredefense/workspaces - }} ``` -{{ List all firmware analysis workspaces in the specified subscription. }} +List all firmware analysis workspaces in the specified subscription. -### Example 2: {{ Get firmware analysis workspace from the specified subscription. }} +### Example 2: Get firmware analysis workspace from the specified subscription. ```powershell -{{ Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName }} +Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName ``` ```output -{{ Id : Location : Name : @@ -43,8 +40,7 @@ SystemDataLastModifiedBy : SystemDataLastModifiedByType : Tag : {} Type : microsoft.iotfirmwaredefense/workspaces -}} ``` -{{ Get firmware analysis workspace from the specified subscription. }} +Get firmware analysis workspace from the specified subscription. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmware.md index 7c5bac948b6c..3755eda210d2 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmware.md @@ -1,10 +1,9 @@ -### Example 1: {{ Create a new firmware using new guid. }} +### Example 1: Create a new firmware using new guid. ```powershell -{{ New-AzFirmwareAnalysisFirmware -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version }} +New-AzFirmwareAnalysisFirmware -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version ``` ```output -{{ Description : description FileName : FileName FileSize : 1 @@ -24,19 +23,16 @@ SystemDataLastModifiedByType : Type : microsoft.iotfirmwaredefense/workspaces/firmwares Vendor : vendor Version : version - }} ``` -{{ Create a new firmware using new guid. }} +Create a new firmware using new guid. -### Example 2: {{ Create a new firmware using a user specified firmwareId. }} +### Example 2: Create a new firmware using a user specified firmwareId. ```powershell -{{ New-AzFirmwareAnalysisFirmware -Id firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version -}} +New-AzFirmwareAnalysisFirmware -Id firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version ``` ```output -{{ Description : description FileName : FileName FileSize : 1 @@ -56,8 +52,7 @@ SystemDataLastModifiedByType : Type : microsoft.iotfirmwaredefense/workspaces/firmwares Vendor : vendor Version : version - }} ``` -{{ Create a new firmware using a user specified firmwareId. }} +Create a new firmware using a user specified firmwareId. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md index cca5b7304b1e..d12c94ee67ed 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl.md @@ -1,6 +1,6 @@ -### Example 1: {{ Get a url for tar file download. }} +### Example 1: Get a url for tar file download. ```powershell -{{ New-AzFirmwareAnalysisFirmwareDownloadUrl -FirmwareId firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName }} +New-AzFirmwareAnalysisFirmwareFilesystemDownloadUrl -FirmwareId firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName ``` -{{ Get a url for tar file download. }} +Get a url for tar file download. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisWorkspace.md index ed6cf1fb4b7b..24f38b45ffe0 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisWorkspace.md @@ -1,10 +1,9 @@ -### Example 1: {{ Create a new firmware analysis workspace. }} +### Example 1: Create a new firmware analysis workspace. ```powershell -{{ New-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name name -Location location }} +New-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name name -Location location ``` ```output -{{ Id : Location : Name : @@ -18,8 +17,7 @@ SystemDataLastModifiedBy : SystemDataLastModifiedByType : Tag : {} Type : microsoft.iotfirmwaredefense/workspaces -}} ``` -{{ Create a new firmware analysis workspace. }} +Create a new firmware analysis workspace. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisWorkspaceUploadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisWorkspaceUploadUrl.md index 18f3ea1d8fb2..a3eee00879d4 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisWorkspaceUploadUrl.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/New-AzFirmwareAnalysisWorkspaceUploadUrl.md @@ -1,15 +1,13 @@ -### Example 1: {{ Create a url for file upload. }} +### Example 1: Create a url for file upload. ```powershell -{{ New-AzFirmwareAnalysisWorkspaceUploadUrl -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -FirmwareId firmwareId }} +New-AzFirmwareAnalysisWorkspaceUploadUrl -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -FirmwareId firmwareId ``` ```output -{{ Url --- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - }} ``` -{{ Create a url for file upload. }} +Create a url for file upload. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Remove-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Remove-AzFirmwareAnalysisFirmware.md index 59f3ef17c2ce..741554fb4aa0 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Remove-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Remove-AzFirmwareAnalysisFirmware.md @@ -1,7 +1,7 @@ -### Example 1: {{ Delete a firmware analysis workspace. }} +### Example 1: Delete a firmware analysis workspace. ```powershell -{{ Remove-AzFirmwareAnalysisFirmware -Id firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName }} +Remove-AzFirmwareAnalysisFirmware -Id firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName ``` -{{ Delete a firmware analysis workspace. }} +Delete a firmware analysis workspace. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Remove-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Remove-AzFirmwareAnalysisWorkspace.md index b1d21b117643..1032dd530f61 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Remove-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Remove-AzFirmwareAnalysisWorkspace.md @@ -1,6 +1,6 @@ -### Example 1: {{ Delete a firmware analysis workspace. }} +### Example 1: Delete a firmware analysis workspace. ```powershell -{{ Remove-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName }} +Remove-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName ``` -{{ Delete a firmware analysis workspace. }} \ No newline at end of file +Delete a firmware analysis workspace. \ No newline at end of file diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Update-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Update-AzFirmwareAnalysisFirmware.md index ab1fd3b70bbe..aa09bfe9b5eb 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Update-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Update-AzFirmwareAnalysisFirmware.md @@ -1,11 +1,9 @@ -### Example 1: {{ Update a firmware. }} +### Example 1: Update a firmware. ```powershell -{{ Update-AzFirmwareAnalysisFirmware -FirmwareId firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version -}} +Update-AzFirmwareAnalysisFirmware -FirmwareId firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -Description description -FileSize 1 -FileName fileName -Vendor vendor -Model model -Version version ``` ```output -{{ Description : description FileName : FileName FileSize : 1 @@ -25,8 +23,7 @@ SystemDataLastModifiedByType : Type : microsoft.iotfirmwaredefense/workspaces/firmwares Vendor : vendor Version : version - }} ``` -{{ Update a firmware. }} +Update a firmware. diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Update-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Update-AzFirmwareAnalysisWorkspace.md index f8bd9e13cc2c..e55f33522b67 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Update-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/examples/Update-AzFirmwareAnalysisWorkspace.md @@ -1,10 +1,9 @@ -### Example 1: {{ Update a firmware analysis workspace. }} +### Example 1: Update a firmware analysis workspace. ```powershell -{{ Update-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName }} +Update-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName ``` ```output -{{ Id : Location : Name : @@ -18,8 +17,7 @@ SystemDataLastModifiedBy : SystemDataLastModifiedByType : Tag : {} Type : microsoft.iotfirmwaredefense/workspaces - }} ``` -{{ Update a firmware analysis workspace. }} +Update a firmware analysis workspace. 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/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