From 349e658d59597ac118b62383a2d7dc969f863d00 Mon Sep 17 00:00:00 2001 From: azure-powershell-bot <65331932+azure-powershell-bot@users.noreply.github.com> Date: Sun, 17 Mar 2024 01:46:53 +0000 Subject: [PATCH] Move FirmwareAnalysis to main --- .../Get-AzFirmwareAnalysisBinaryHardening.ps1 | 2 +- ...et-AzFirmwareAnalysisCryptoCertificate.ps1 | 2 +- .../Get-AzFirmwareAnalysisCryptoKey.ps1 | 2 +- .../exports/Get-AzFirmwareAnalysisCve.ps1 | 2 +- .../Get-AzFirmwareAnalysisFirmware.ps1 | 4 +- .../Get-AzFirmwareAnalysisPasswordHash.ps1 | 2 +- .../Get-AzFirmwareAnalysisSbomComponent.ps1 | 2 +- .../exports/Get-AzFirmwareAnalysisSummary.ps1 | 5 +- .../Get-AzFirmwareAnalysisWorkspace.ps1 | 3 +- .../New-AzFirmwareAnalysisFirmware.ps1 | 3 +- .../New-AzFirmwareAnalysisWorkspace.ps1 | 2 +- ...w-AzFirmwareAnalysisWorkspaceUploadUrl.ps1 | 4 +- .../exports/ProxyCmdletDefinitions.ps1 | 48 ++-- .../Remove-AzFirmwareAnalysisFirmware.ps1 | 4 +- .../Remove-AzFirmwareAnalysisWorkspace.ps1 | 3 +- .../Update-AzFirmwareAnalysisFirmware.ps1 | 5 +- .../Update-AzFirmwareAnalysisWorkspace.ps1 | 3 +- .../runtime/BuildTime/Models/PsProxyTypes.cs | 4 +- .../help/Get-AzFirmwareAnalysisFirmware.md | 2 - .../help/Get-AzFirmwareAnalysisSummary.md | 3 - .../help/Get-AzFirmwareAnalysisWorkspace.md | 1 - .../help/New-AzFirmwareAnalysisFirmware.md | 1 - ...ew-AzFirmwareAnalysisWorkspaceUploadUrl.md | 2 - .../help/Remove-AzFirmwareAnalysisFirmware.md | 2 - .../Remove-AzFirmwareAnalysisWorkspace.md | 1 - .../help/Update-AzFirmwareAnalysisFirmware.md | 3 - .../Update-AzFirmwareAnalysisWorkspace.md | 1 - .../Get-AzFirmwareAnalysisOperation.ps1 | 2 +- .../internal/ProxyCmdletDefinitions.ps1 | 2 +- .../FirmwareAnalysis/Az.FirmwareAnalysis.psd1 | 260 +++++++++--------- .../Get-AzFirmwareAnalysisBinaryHardening.md | 125 +++------ ...Get-AzFirmwareAnalysisCryptoCertificate.md | 143 ++++------ .../help/Get-AzFirmwareAnalysisCryptoKey.md | 125 +++------ .../help/Get-AzFirmwareAnalysisCve.md | 129 +++------ .../help/Get-AzFirmwareAnalysisFirmware.md | 189 +++++-------- .../Get-AzFirmwareAnalysisPasswordHash.md | 121 +++----- .../Get-AzFirmwareAnalysisSbomComponent.md | 119 +++----- .../help/Get-AzFirmwareAnalysisSummary.md | 184 ++++--------- .../help/Get-AzFirmwareAnalysisWorkspace.md | 163 ++++------- .../help/New-AzFirmwareAnalysisFirmware.md | 156 ++++------- .../help/New-AzFirmwareAnalysisWorkspace.md | 114 ++------ ...ew-AzFirmwareAnalysisWorkspaceUploadUrl.md | 149 ++-------- .../help/Remove-AzFirmwareAnalysisFirmware.md | 136 ++------- .../Remove-AzFirmwareAnalysisWorkspace.md | 120 +------- .../help/Update-AzFirmwareAnalysisFirmware.md | 157 +++-------- .../Update-AzFirmwareAnalysisWorkspace.md | 132 ++------- 46 files changed, 782 insertions(+), 1860 deletions(-) diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisBinaryHardening.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisBinaryHardening.ps1 index 34afc1b2d0ca..64b5ac6bac7e 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisBinaryHardening.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisBinaryHardening.ps1 @@ -70,7 +70,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCryptoCertificate.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCryptoCertificate.ps1 index 5c6caba53f9f..9a735153098e 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCryptoCertificate.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCryptoCertificate.ps1 @@ -70,7 +70,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCryptoKey.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCryptoKey.ps1 index a79554d42c78..12a0b12113a0 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCryptoKey.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCryptoKey.ps1 @@ -70,7 +70,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCve.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCve.ps1 index fd906053fcab..c9096e0d3fa4 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCve.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisCve.ps1 @@ -70,7 +70,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisFirmware.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisFirmware.ps1 index c2882fb5b650..4eb0cd4209c4 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisFirmware.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisFirmware.ps1 @@ -91,14 +91,12 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='GetViaIdentityWorkspace', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${WorkspaceInputObject}, [Parameter()] @@ -113,7 +111,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisPasswordHash.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisPasswordHash.ps1 index 2e7e586283e5..eb3b8a8f1ea3 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisPasswordHash.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisPasswordHash.ps1 @@ -70,7 +70,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisSbomComponent.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisSbomComponent.ps1 index 56c19eb8765c..15cd00d692e2 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisSbomComponent.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisSbomComponent.ps1 @@ -70,7 +70,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisSummary.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisSummary.ps1 index c1fbf8d19289..ec8a53cd980f 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisSummary.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisSummary.ps1 @@ -105,21 +105,18 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='GetViaIdentityFirmware', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${FirmwareInputObject}, [Parameter(ParameterSetName='GetViaIdentityWorkspace', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${WorkspaceInputObject}, [Parameter()] @@ -134,7 +131,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisWorkspace.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisWorkspace.ps1 index e1c52db1f914..8fdd03fc3023 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisWorkspace.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Get-AzFirmwareAnalysisWorkspace.ps1 @@ -76,7 +76,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter()] @@ -91,7 +90,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisFirmware.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisFirmware.ps1 index d53300ceaf70..6330d33bca7d 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisFirmware.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisFirmware.ps1 @@ -106,7 +106,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IStatusMessage[]] # A list of errors or other messages generated during firmware analysis - # . ${StatusMessage}, [Parameter()] @@ -133,7 +132,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisWorkspace.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisWorkspace.ps1 index b1966d1a1384..44900b3cdc20 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisWorkspace.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisWorkspace.ps1 @@ -78,7 +78,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisWorkspaceUploadUrl.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisWorkspaceUploadUrl.ps1 index b8611ee1ad61..51e0005e579f 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisWorkspaceUploadUrl.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/New-AzFirmwareAnalysisWorkspaceUploadUrl.ps1 @@ -85,7 +85,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='Generate', Mandatory, ValueFromPipeline)] @@ -93,7 +92,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IGenerateUploadUrlRequest] # Properties for generating an upload URL - # . ${GenerateUploadUrl}, [Parameter(ParameterSetName='GenerateExpanded')] @@ -127,7 +125,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/ProxyCmdletDefinitions.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/ProxyCmdletDefinitions.ps1 index 87aef34963e1..5c2522b343a1 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/ProxyCmdletDefinitions.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/ProxyCmdletDefinitions.ps1 @@ -70,7 +70,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -244,7 +244,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -418,7 +418,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -592,7 +592,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -787,14 +787,12 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='GetViaIdentityWorkspace', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${WorkspaceInputObject}, [Parameter()] @@ -809,7 +807,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -986,7 +984,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -1160,7 +1158,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -1369,21 +1367,18 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='GetViaIdentityFirmware', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${FirmwareInputObject}, [Parameter(ParameterSetName='GetViaIdentityWorkspace', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${WorkspaceInputObject}, [Parameter()] @@ -1398,7 +1393,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -1581,7 +1576,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter()] @@ -1596,7 +1590,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -1809,7 +1803,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IStatusMessage[]] # A list of errors or other messages generated during firmware analysis - # . ${StatusMessage}, [Parameter()] @@ -1836,7 +1829,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -2028,7 +2021,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='Generate', Mandatory, ValueFromPipeline)] @@ -2036,7 +2028,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IGenerateUploadUrlRequest] # Properties for generating an upload URL - # . ${GenerateUploadUrl}, [Parameter(ParameterSetName='GenerateExpanded')] @@ -2070,7 +2061,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -2257,7 +2248,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -2447,14 +2438,12 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='DeleteViaIdentityWorkspace', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${WorkspaceInputObject}, [Parameter()] @@ -2469,7 +2458,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -2652,7 +2641,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter()] @@ -2667,7 +2655,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -2868,14 +2856,12 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='UpdateViaIdentityWorkspaceExpanded', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${WorkspaceInputObject}, [Parameter()] @@ -2914,7 +2900,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IStatusMessage[]] # A list of errors or other messages generated during firmware analysis - # . ${StatusMessage}, [Parameter()] @@ -2941,7 +2926,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] @@ -3118,7 +3103,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter()] @@ -3133,7 +3117,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Remove-AzFirmwareAnalysisFirmware.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Remove-AzFirmwareAnalysisFirmware.ps1 index 4284b0590ab2..ac34b8f2c308 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Remove-AzFirmwareAnalysisFirmware.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Remove-AzFirmwareAnalysisFirmware.ps1 @@ -86,14 +86,12 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='DeleteViaIdentityWorkspace', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${WorkspaceInputObject}, [Parameter()] @@ -108,7 +106,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Remove-AzFirmwareAnalysisWorkspace.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Remove-AzFirmwareAnalysisWorkspace.ps1 index bf1df7235f9d..f5b1a812a6fc 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Remove-AzFirmwareAnalysisWorkspace.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Remove-AzFirmwareAnalysisWorkspace.ps1 @@ -71,7 +71,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter()] @@ -86,7 +85,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Update-AzFirmwareAnalysisFirmware.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Update-AzFirmwareAnalysisFirmware.ps1 index 90945111a537..61d40496077d 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Update-AzFirmwareAnalysisFirmware.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Update-AzFirmwareAnalysisFirmware.ps1 @@ -90,14 +90,12 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter(ParameterSetName='UpdateViaIdentityWorkspaceExpanded', Mandatory, ValueFromPipeline)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${WorkspaceInputObject}, [Parameter()] @@ -136,7 +134,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Body')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IStatusMessage[]] # A list of errors or other messages generated during firmware analysis - # . ${StatusMessage}, [Parameter()] @@ -163,7 +160,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Update-AzFirmwareAnalysisWorkspace.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Update-AzFirmwareAnalysisWorkspace.ps1 index 97e47f3b9994..bdb1a0b825d8 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Update-AzFirmwareAnalysisWorkspace.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/exports/Update-AzFirmwareAnalysisWorkspace.ps1 @@ -71,7 +71,6 @@ param( [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity] # Identity Parameter - # . ${InputObject}, [Parameter()] @@ -86,7 +85,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/generated/runtime/BuildTime/Models/PsProxyTypes.cs b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/generated/runtime/BuildTime/Models/PsProxyTypes.cs index 1652fcd5a39e..e810a865bbe1 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/generated/runtime/BuildTime/Models/PsProxyTypes.cs +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/generated/runtime/BuildTime/Models/PsProxyTypes.cs @@ -308,10 +308,10 @@ public Parameter(string variantName, string parameterName, ParameterMetadata met IsMandatory = ParameterAttribute.Mandatory; var complexParameterName = ParameterName.ToUpperInvariant(); - var complexMessage = $"{Environment.NewLine}."; + var complexMessage = $"{Environment.NewLine}"; var description = ParameterAttribute.HelpMessage.NullIfEmpty() ?? HelpInfo.Description.NullIfEmpty() ?? InfoAttribute?.Description.NullIfEmpty() ?? String.Empty; // Remove the complex type message as it will be reinserted if this is a complex type - description = description.NormalizeNewLines().Replace(complexMessage, String.Empty).Replace(complexMessage.ToPsSingleLine(), String.Empty); + description = description.NormalizeNewLines(); // Make an InfoAttribute for processing only if one isn't provided InfoAttribute = Attributes.OfType().FirstOrDefault() ?? new InfoAttribute { PossibleTypes = new[] { ParameterType.Unwrap() }, Required = IsMandatory }; // Set the description if the InfoAttribute does not have one since they are exported without a description diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisFirmware.md index 9a457a8f8660..eaad5909de19 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisFirmware.md @@ -134,7 +134,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -182,7 +181,6 @@ Accept wildcard characters: False ### -WorkspaceInputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisSummary.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisSummary.md index 5aac73c0dc89..7ca75949797c 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisSummary.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisSummary.md @@ -120,7 +120,6 @@ Accept wildcard characters: False ### -FirmwareInputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -136,7 +135,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -199,7 +197,6 @@ Accept wildcard characters: False ### -WorkspaceInputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisWorkspace.md index 97f437f8ad02..df796a48a62b 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Get-AzFirmwareAnalysisWorkspace.md @@ -106,7 +106,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/New-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/New-AzFirmwareAnalysisFirmware.md index 66044be3a3ea..10b36dd1bfea 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/New-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/New-AzFirmwareAnalysisFirmware.md @@ -208,7 +208,6 @@ Accept wildcard characters: False ### -StatusMessage A list of errors or other messages generated during firmware analysis -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IStatusMessage[] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/New-AzFirmwareAnalysisWorkspaceUploadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/New-AzFirmwareAnalysisWorkspaceUploadUrl.md index e59e475d4137..af37dfc87120 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/New-AzFirmwareAnalysisWorkspaceUploadUrl.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/New-AzFirmwareAnalysisWorkspaceUploadUrl.md @@ -106,7 +106,6 @@ Accept wildcard characters: False ### -GenerateUploadUrl Properties for generating an upload URL -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IGenerateUploadUrlRequest @@ -122,7 +121,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Remove-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Remove-AzFirmwareAnalysisFirmware.md index 9c367e9ea9d5..89e1e46941f7 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Remove-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Remove-AzFirmwareAnalysisFirmware.md @@ -77,7 +77,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -140,7 +139,6 @@ Accept wildcard characters: False ### -WorkspaceInputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Remove-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Remove-AzFirmwareAnalysisWorkspace.md index 67c8ed307cc9..d207577961c0 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Remove-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Remove-AzFirmwareAnalysisWorkspace.md @@ -56,7 +56,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Update-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Update-AzFirmwareAnalysisFirmware.md index 4b97a7cb9304..a08ae7f589fc 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Update-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Update-AzFirmwareAnalysisFirmware.md @@ -150,7 +150,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -212,7 +211,6 @@ Accept wildcard characters: False ### -StatusMessage A list of errors or other messages generated during firmware analysis -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IStatusMessage[] @@ -274,7 +272,6 @@ Accept wildcard characters: False ### -WorkspaceInputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Update-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Update-AzFirmwareAnalysisWorkspace.md index 3ac4c0e05e99..d08129dcdbe6 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Update-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/help/Update-AzFirmwareAnalysisWorkspace.md @@ -72,7 +72,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/internal/Get-AzFirmwareAnalysisOperation.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/internal/Get-AzFirmwareAnalysisOperation.ps1 index cd5989b500a6..2283f81aca9f 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/internal/Get-AzFirmwareAnalysisOperation.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/internal/Get-AzFirmwareAnalysisOperation.ps1 @@ -45,7 +45,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/internal/ProxyCmdletDefinitions.ps1 b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/internal/ProxyCmdletDefinitions.ps1 index cd5989b500a6..2283f81aca9f 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/internal/ProxyCmdletDefinitions.ps1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis.Autorest/internal/ProxyCmdletDefinitions.ps1 @@ -45,7 +45,7 @@ param( [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Category('Runtime')] [System.Management.Automation.SwitchParameter] - # Wait forNET debugger to attach + # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/Az.FirmwareAnalysis.psd1 b/src/FirmwareAnalysis/FirmwareAnalysis/Az.FirmwareAnalysis.psd1 index 267a624aad6e..815c53b06756 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/Az.FirmwareAnalysis.psd1 +++ b/src/FirmwareAnalysis/FirmwareAnalysis/Az.FirmwareAnalysis.psd1 @@ -3,132 +3,142 @@ # # Generated by: Microsoft Corporation # -# Generated on: 2/24/2024 +# Generated on: 3/17/2024 # @{ - # Script module or binary module file associated with this manifest. - # RootModule = '' - - # Version number of this module. - ModuleVersion = '0.1.0' - - # Supported PSEditions - CompatiblePSEditions = 'Core', 'Desktop' - - # ID used to uniquely identify this module - GUID = 'accceef6-8113-453a-a31c-4f2ce57893d6' - - # Author of this module - Author = 'Microsoft Corporation' - - # Company or vendor of this module - CompanyName = 'Microsoft Corporation' - - # Copyright statement for this module - Copyright = 'Microsoft Corporation. All rights reserved.' - - # Description of the functionality provided by this module - Description = 'Microsoft Azure PowerShell: {ModuleNamePlaceHolder} cmdlets' - - # Minimum version of the Windows PowerShell engine required by this module - PowerShellVersion = '5.1' - - # Name of the Windows PowerShell host required by this module - # PowerShellHostName = '' - - # Minimum version of the Windows PowerShell host required by this module - # PowerShellHostVersion = '' - - # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. - DotNetFrameworkVersion = '4.7.2' - - # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. - # CLRVersion = '' - - # Processor architecture (None, X86, Amd64) required by this module - # ProcessorArchitecture = '' - - # Modules that must be imported into the global environment prior to importing this module - # RequiredModules = @() - - # Assemblies that must be loaded prior to importing this module - RequiredAssemblies = 'FirmwareAnalysis.Autorest/bin/Az.FirmwareAnalysis.private.dll' - - # Script files (.ps1) that are run in the caller's environment prior to importing this module. - # ScriptsToProcess = @() - - # Type files (.ps1xml) to be loaded when importing this module - # TypesToProcess = @() - - # Format files (.ps1xml) to be loaded when importing this module - FormatsToProcess = 'FirmwareAnalysis.Autorest/Az.FirmwareAnalysis.format.ps1xml' - - # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess - NestedModules = @('FirmwareAnalysis.Autorest/Az.FirmwareAnalysis.psm1') - - # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. - FunctionsToExport = 'Get-AzFirmwareAnalysisBinaryHardening', - 'Get-AzFirmwareAnalysisCryptoCertificate', - 'Get-AzFirmwareAnalysisCryptoKey', 'Get-AzFirmwareAnalysisCve', - 'Get-AzFirmwareAnalysisFirmware', - 'Get-AzFirmwareAnalysisPasswordHash', - 'Get-AzFirmwareAnalysisSbomComponent', - 'Get-AzFirmwareAnalysisSummary', 'Get-AzFirmwareAnalysisWorkspace', - 'New-AzFirmwareAnalysisFirmware', 'New-AzFirmwareAnalysisWorkspace', - 'New-AzFirmwareAnalysisWorkspaceUploadUrl', - 'Remove-AzFirmwareAnalysisFirmware', - 'Remove-AzFirmwareAnalysisWorkspace', - 'Update-AzFirmwareAnalysisFirmware', - 'Update-AzFirmwareAnalysisWorkspace' - - # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. - CmdletsToExport = @() - - # Variables to export from this module - VariablesToExport = '*' - - # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. - AliasesToExport = '*' - - # DSC resources to export from this module - # DscResourcesToExport = @() - - # List of all modules packaged with this module - # ModuleList = @() - - # List of all files packaged with this module - # FileList = @() - - # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. - PrivateData = @{ - - PSData = @{ - - # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', '{ModuleNamePlaceHolder}' - - # A URL to the license for this module. - LicenseUri = 'https://aka.ms/azps-license' - - # A URL to the main website for this project. - ProjectUri = 'https://github.com/Azure/azure-powershell' - - # A URL to an icon representing this module. - # IconUri = '' - - # ReleaseNotes of this module - # ReleaseNotes = '' - - } # End of PSData hashtable - - } # End of PrivateData hashtable - - # HelpInfo URI of this module - # HelpInfoURI = '' - - # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. - # DefaultCommandPrefix = '' - -} \ No newline at end of file +# Script module or binary module file associated with this manifest. +# RootModule = '' + +# Version number of this module. +ModuleVersion = '0.1.0' + +# Supported PSEditions +CompatiblePSEditions = 'Core', 'Desktop' + +# ID used to uniquely identify this module +GUID = 'accceef6-8113-453a-a31c-4f2ce57893d6' + +# Author of this module +Author = 'Microsoft Corporation' + +# Company or vendor of this module +CompanyName = 'Microsoft Corporation' + +# Copyright statement for this module +Copyright = 'Microsoft Corporation. All rights reserved.' + +# Description of the functionality provided by this module +Description = 'Microsoft Azure PowerShell: {ModuleNamePlaceHolder} cmdlets' + +# Minimum version of the PowerShell engine required by this module +PowerShellVersion = '5.1' + +# Name of the PowerShell host required by this module +# PowerShellHostName = '' + +# Minimum version of the PowerShell host required by this module +# PowerShellHostVersion = '' + +# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +DotNetFrameworkVersion = '4.7.2' + +# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +# ClrVersion = '' + +# Processor architecture (None, X86, Amd64) required by this module +# ProcessorArchitecture = '' + +# Modules that must be imported into the global environment prior to importing this module +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.16.0'; }) + +# Assemblies that must be loaded prior to importing this module +RequiredAssemblies = 'FirmwareAnalysis.Autorest/bin/Az.FirmwareAnalysis.private.dll' + +# Script files (.ps1) that are run in the caller's environment prior to importing this module. +ScriptsToProcess = @() + +# Type files (.ps1xml) to be loaded when importing this module +TypesToProcess = @() + +# Format files (.ps1xml) to be loaded when importing this module +FormatsToProcess = 'FirmwareAnalysis.Autorest/Az.FirmwareAnalysis.format.ps1xml' + +# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess +NestedModules = @('FirmwareAnalysis.Autorest/Az.FirmwareAnalysis.psm1') + +# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. +FunctionsToExport = 'Get-AzFirmwareAnalysisBinaryHardening', + 'Get-AzFirmwareAnalysisCryptoCertificate', + 'Get-AzFirmwareAnalysisCryptoKey', 'Get-AzFirmwareAnalysisCve', + 'Get-AzFirmwareAnalysisFirmware', + 'Get-AzFirmwareAnalysisPasswordHash', + 'Get-AzFirmwareAnalysisSbomComponent', + 'Get-AzFirmwareAnalysisSummary', 'Get-AzFirmwareAnalysisWorkspace', + 'New-AzFirmwareAnalysisFirmware', 'New-AzFirmwareAnalysisWorkspace', + 'New-AzFirmwareAnalysisWorkspaceUploadUrl', + 'Remove-AzFirmwareAnalysisFirmware', + 'Remove-AzFirmwareAnalysisWorkspace', + 'Update-AzFirmwareAnalysisFirmware', + 'Update-AzFirmwareAnalysisWorkspace' + +# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. +CmdletsToExport = @() + +# Variables to export from this module +# VariablesToExport = @() + +# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. +AliasesToExport = @() + +# DSC resources to export from this module +# DscResourcesToExport = @() + +# List of all modules packaged with this module +# ModuleList = @() + +# List of all files packaged with this module +# FileList = @() + +# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. +PrivateData = @{ + + PSData = @{ + + # Tags applied to this module. These help with module discovery in online galleries. + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', '{ModuleNamePlaceHolder}' + + # A URL to the license for this module. + LicenseUri = 'https://aka.ms/azps-license' + + # A URL to the main website for this project. + ProjectUri = 'https://github.com/Azure/azure-powershell' + + # A URL to an icon representing this module. + # IconUri = '' + + # ReleaseNotes of this module + # ReleaseNotes = '' + + # Prerelease string of this module + # Prerelease = '' + + # Flag to indicate whether the module requires explicit user acceptance for install/update/save + # RequireLicenseAcceptance = $false + + # External dependent modules of this module + # ExternalModuleDependencies = @() + + } # End of PSData hashtable + +} # End of PrivateData hashtable + +# HelpInfo URI of this module +# HelpInfoURI = '' + +# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. +# DefaultCommandPrefix = '' + +} + diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisBinaryHardening.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisBinaryHardening.md index 92f16c736dc9..cb3bc2bd7baf 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisBinaryHardening.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisBinaryHardening.md @@ -14,9 +14,8 @@ Lists binary hardening analysis results of a firmware. ``` Get-AzFirmwareAnalysisBinaryHardening -FirmwareId -ResourceGroupName -WorkspaceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -24,27 +23,41 @@ Lists binary hardening analysis results of a firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List all the binary hardening analysis results for a firmware. +```powershell Get-AzFirmwareAnalysisBinaryHardening -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json ``` -## PARAMETERS +```output +[ + { + "Architecture": "", + "BinaryHardeningId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "Class": "", + "FeatureCanary": boolean, + "FeatureNx": boolean, + "FeaturePie": boolean, + "FeatureRelro": boolean, + "FeatureStripped": boolean, + "FilePath": "filePath", + "Id": "id", + "Name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "Rpath": "", + "Runpath": "", + "SystemDataCreatedAt": "", + "SystemDataCreatedBy": "", + "SystemDataCreatedByType": "", + "SystemDataLastModifiedAt": "", + "SystemDataLastModifiedBy": "", + "SystemDataLastModifiedByType": "", + "Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/binaryHardeningResults" + } +] +``` -### -Break -Wait forNET debugger to attach +List all the binary hardening analysis results for a firmware. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -77,13 +90,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -92,66 +105,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -179,7 +132,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -207,9 +160,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IBinaryHardeningResource + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysisbinaryhardening](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysisbinaryhardening) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCryptoCertificate.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCryptoCertificate.md index de7c66e47035..df27d46cabe8 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCryptoCertificate.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCryptoCertificate.md @@ -14,9 +14,8 @@ Lists cryptographic certificate analysis results found in a firmware. ``` Get-AzFirmwareAnalysisCryptoCertificate -FirmwareId -ResourceGroupName - -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] + -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -24,27 +23,59 @@ Lists cryptographic certificate analysis results found in a firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List all the crypto certificate analysis results for a firmware. +```powershell Get-AzFirmwareAnalysisCryptoCertificate -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json ``` -## PARAMETERS +```output +[ + { + "CryptoCertId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "Encoding": "", + "ExpirationDate": "", + "FilePath": [""], + "Fingerprint": "", + "Id": "", + "IsExpired": boolean, + "IsSelfSigned": boolean, + "IsShortKeySize": boolean, + "IsWeakSignature": "", + "IssuedDate": "", + "IssuerCommonName": "", + "IssuerCountry": "", + "IssuerOrganization": "", + "IssuerOrganizationalUnit": "", + "IssuerState": "", + "KeyAlgorithm": "", + "KeySize": , + "Name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "PairedKeyId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "PairedKeyType": "", + "PropertiesName": "", + "Role": "", + "SerialNumber": "", + "SignatureAlgorithm": "", + "SubjectCommonName": "", + "SubjectCountry": "", + "SubjectOrganization": "", + "SubjectOrganizationalUnit": "", + "SubjectState": "", + "SystemDataCreatedAt": , + "SystemDataCreatedBy": , + "SystemDataCreatedByType": , + "SystemDataLastModifiedAt": , + "SystemDataLastModifiedBy": , + "SystemDataLastModifiedByType": , + "Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cryptoCertificates", + "Usage": [] + } +] +``` -### -Break -Wait forNET debugger to attach +List all the crypto certificate analysis results for a firmware. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -77,13 +108,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -92,66 +123,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -179,7 +150,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -207,9 +178,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.ICryptoCertificateResource + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysiscryptocertificate](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysiscryptocertificate) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCryptoKey.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCryptoKey.md index a7cbaa8a5e29..2051d13c2e72 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCryptoKey.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCryptoKey.md @@ -14,9 +14,8 @@ Lists cryptographic key analysis results found in a firmware. ``` Get-AzFirmwareAnalysisCryptoKey -FirmwareId -ResourceGroupName -WorkspaceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -24,27 +23,41 @@ Lists cryptographic key analysis results found in a firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List all the crypto key analysis results for a firmware. +```powershell Get-AzFirmwareAnalysisCryptoKey -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json ``` -## PARAMETERS +```output +[ + { + "CryptoKeyId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "FilePath": [""], + "Id": "", + "IsShortKeySize": , + "KeyAlgorithm": "", + "KeySize": , + "KeyType": "", + "Name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "PairedKeyId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "PairedKeyType": "", + "SystemDataCreatedAt": , + "SystemDataCreatedBy": , + "SystemDataCreatedByType": , + "SystemDataLastModifiedAt": , + "SystemDataLastModifiedBy": , + "SystemDataLastModifiedByType": , + "Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cryptoKeys", + "Usage": [ + "" + ] + } +] +``` -### -Break -Wait forNET debugger to attach +List all the crypto key analysis results for a firmware. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -77,13 +90,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -92,66 +105,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -179,7 +132,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -207,9 +160,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.ICryptoKeyResource + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysiscryptokey](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysiscryptokey) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCve.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCve.md index 8144594e9f04..3419312d052c 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCve.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisCve.md @@ -14,9 +14,8 @@ Lists CVE analysis results of a firmware. ``` Get-AzFirmwareAnalysisCve -FirmwareId -ResourceGroupName -WorkspaceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -24,27 +23,45 @@ Lists CVE analysis results of a firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List all the cve analysis results for a firmware. +```powershell Get-AzFirmwareAnalysisCve -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json ``` -## PARAMETERS +```output +[ + { + "ComponentId": , + "ComponentName": "", + "ComponentVersion": "", + "CveId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "CvssScore": "", + "CvssV2Score": "", + "CvssV3Score": "", + "CvssVersion": "", + "Description": "", + "Id": "", + "Link": [ + "", + "" + ], + "Name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "PropertiesName": "", + "Severity": "", + "SystemDataCreatedAt": , + "SystemDataCreatedBy": , + "SystemDataCreatedByType": , + "SystemDataLastModifiedAt": , + "SystemDataLastModifiedBy": , + "SystemDataLastModifiedByType": , + "Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/cves" + } +] +``` -### -Break -Wait forNET debugger to attach +List all the cve analysis results for a firmware. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -77,13 +94,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -92,66 +109,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -179,7 +136,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -207,9 +164,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.ICveResource + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysiscve](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysiscve) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisFirmware.md index 26ebf8915d7f..900902582a96 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisFirmware.md @@ -15,32 +15,25 @@ Get firmware. ### List (Default) ``` Get-AzFirmwareAnalysisFirmware -ResourceGroupName [-SubscriptionId ] -WorkspaceName - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentityWorkspace ``` Get-AzFirmwareAnalysisFirmware -Id -WorkspaceInputObject - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzFirmwareAnalysisFirmware -Id -ResourceGroupName [-SubscriptionId ] - -WorkspaceName [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + -WorkspaceName [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzFirmwareAnalysisFirmware -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFirmwareAnalysisFirmware -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -48,32 +41,65 @@ Get firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List all the firmwares inside a workspace. +```powershell Get-AzFirmwareAnalysisFirmware -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName ``` -### EXAMPLE 2 -``` +```output +Description : +FileName : +FileSize : +Id : +Model : +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +ProvisioningState : +ResourceGroupName : +Status : +StatusMessage : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SystemDataLastModifiedByType : +Type : microsoft.iotfirmwaredefense/workspaces/firmwares +Vendor : +Version : +``` + +List all the firmwares inside a workspace. + +### Example 2: Get a firmware inside a workspace. +```powershell Get-AzFirmwareAnalysisFirmware -Id FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName ``` -## PARAMETERS - -### -Break -Wait forNET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +Description : +FileName : +FileSize : +Id : +Model : +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +ProvisioningState : +ResourceGroupName : +Status : +StatusMessage : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +SystemDataLastModifiedByType : +Type : microsoft.iotfirmwaredefense/workspaces/firmwares +Vendor : +Version : +``` + +Get a firmware inside a workspace. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -91,36 +117,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Id The id of the firmware. @@ -138,7 +134,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -152,13 +147,13 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -167,36 +162,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -224,14 +189,13 @@ Aliases: Required: False Position: Named -Default value: None +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 @@ -266,36 +230,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmware -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. - -WORKSPACEINPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysisfirmware](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysisfirmware) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisPasswordHash.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisPasswordHash.md index ec4660253ab8..5e9b74cc73bf 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisPasswordHash.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisPasswordHash.md @@ -14,9 +14,8 @@ Lists password hash analysis results of a firmware. ``` Get-AzFirmwareAnalysisPasswordHash -FirmwareId -ResourceGroupName -WorkspaceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -24,27 +23,37 @@ Lists password hash analysis results of a firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List all the password hash analysis results for a firmware. +```powershell Get-AzFirmwareAnalysisPasswordHash -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json ``` -## PARAMETERS +```output +[ + { + "Algorithm": "", + "Context": "", + "FilePath": "/path/to/file", + "Hash": "", + "Id": "", + "Name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "PasswordHashId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "Salt": "", + "SystemDataCreatedAt": , + "SystemDataCreatedBy": , + "SystemDataCreatedByType": , + "SystemDataLastModifiedAt": , + "SystemDataLastModifiedBy": , + "SystemDataLastModifiedByType": , + "Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/passwordHashes", + "Username": "" + } +] +``` -### -Break -Wait forNET debugger to attach +List all the password hash analysis results for a firmware. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -77,13 +86,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -92,66 +101,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -179,7 +128,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -207,9 +156,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IPasswordHashResource + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysispasswordhash](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysispasswordhash) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisSbomComponent.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisSbomComponent.md index cdc651594c03..0096f19709c1 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisSbomComponent.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisSbomComponent.md @@ -14,9 +14,8 @@ Lists SBOM analysis results of a firmware. ``` Get-AzFirmwareAnalysisSbomComponent -FirmwareId -ResourceGroupName -WorkspaceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -24,27 +23,35 @@ Lists SBOM analysis results of a firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List all the sbom component analysis results for a firmware. +```powershell Get-AzFirmwareAnalysisSbomComponent -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName | ConvertTo-Json ``` -## PARAMETERS +```output +[ + { + "ComponentId": "", + "ComponentName": "", + "FilePath": [""], + "Id": "", + "License": "", + "Name": "", + "SystemDataCreatedAt": , + "SystemDataCreatedBy": , + "SystemDataCreatedByType": , + "SystemDataLastModifiedAt": , + "SystemDataLastModifiedBy": , + "SystemDataLastModifiedByType": , + "Type": "Microsoft.IoTFirmwareDefense/workspaces/firmwares/sbomComponents", + "Version": "" + } +] +``` -### -Break -Wait forNET debugger to attach +List all the sbom component analysis results for a firmware. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -77,13 +84,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -92,66 +99,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -179,7 +126,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -207,9 +154,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.ISbomComponentResource + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysissbomcomponent](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysissbomcomponent) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisSummary.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisSummary.md index 3768826b3040..f0c669ba4cd7 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisSummary.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisSummary.md @@ -15,32 +15,27 @@ Get an analysis result summary of a firmware by name. ### Get (Default) ``` Get-AzFirmwareAnalysisSummary -FirmwareId -Name -ResourceGroupName - [-SubscriptionId ] -WorkspaceName [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] -WorkspaceName [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentityWorkspace ``` Get-AzFirmwareAnalysisSummary -FirmwareId -Name - -WorkspaceInputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] + -WorkspaceInputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentityFirmware ``` Get-AzFirmwareAnalysisSummary -Name -FirmwareInputObject - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzFirmwareAnalysisSummary -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFirmwareAnalysisSummary -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -48,32 +43,51 @@ Get an analysis result summary of a firmware by name. ## EXAMPLES -### EXAMPLE 1 -``` +### 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 ``` -### EXAMPLE 2 +```output +Id : +Name : +Property : +ResourceGroupName : +SummaryType : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries ``` + +List all the analysis results summary for a firmware by analysis type CVE. + +### Example 2: List all the analysis results summary for a firmware by analysis type Firmware. +```powershell Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Name Type ``` -## PARAMETERS - -### -Break -Wait forNET debugger to attach +```output +Id : +Name : +Property : +ResourceGroupName : +SummaryType : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.IoTFirmwareDefense/workspaces/firmwares/summaries +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +List all the analysis results summary for a firmware by analysis type Firmware. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -108,7 +122,6 @@ Accept wildcard characters: False ### -FirmwareInputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -122,39 +135,8 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -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 @@ -183,28 +165,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -213,21 +180,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -255,14 +207,13 @@ Aliases: Required: False Position: Named -Default value: None +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 @@ -297,46 +248,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.ISummaryResource -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -FIRMWAREINPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. - -INPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. - -WORKSPACEINPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysissummary](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysissummary) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisWorkspace.md index 0064d748e13d..791c7789c42d 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Get-AzFirmwareAnalysisWorkspace.md @@ -14,32 +14,26 @@ Get firmware analysis workspace. ### List (Default) ``` -Get-AzFirmwareAnalysisWorkspace [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFirmwareAnalysisWorkspace [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzFirmwareAnalysisWorkspace -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzFirmwareAnalysisWorkspace -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzFirmwareAnalysisWorkspace -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFirmwareAnalysisWorkspace -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -47,32 +41,53 @@ Get firmware analysis workspace. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List all firmware analysis workspaces in the specified subscription. +```powershell Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName ``` -### EXAMPLE 2 +```output +Id : +Location : +Name : +ProvisioningState : +ResourceGroupName : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : {} +Type : microsoft.iotfirmwaredefense/workspaces ``` + +List all firmware analysis workspaces in the specified subscription. + +### Example 2: Get firmware analysis workspace from the specified subscription. +```powershell Get-AzFirmwareAnalysisWorkspace -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName ``` -## PARAMETERS - -### -Break -Wait forNET debugger to attach +```output +Id : +Location : +Name : +ProvisioningState : +ResourceGroupName : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : {} +Type : microsoft.iotfirmwaredefense/workspaces +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +Get firmware analysis workspace from the specified subscription. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -90,39 +105,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -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 @@ -151,28 +135,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -181,21 +150,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -223,7 +177,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -234,26 +188,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IWorkspace -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysisworkspace](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/get-azfirmwareanalysisworkspace) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisFirmware.md index 42a9cef4a013..2e317934f691 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisFirmware.md @@ -16,9 +16,7 @@ The operation to create a firmware. New-AzFirmwareAnalysisFirmware -ResourceGroupName -WorkspaceName [-Id ] [-SubscriptionId ] [-Description ] [-FileName ] [-FileSize ] [-Model ] [-Status ] [-StatusMessage ] [-Vendor ] [-Version ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -26,32 +24,65 @@ The operation to create a firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### 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 ``` -### EXAMPLE 2 +```output +Description : description +FileName : FileName +FileSize : 1 +Id : +Model : model +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +ProvisioningState : +ResourceGroupName : +Status : +StatusMessage : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : microsoft.iotfirmwaredefense/workspaces/firmwares +Vendor : vendor +Version : version ``` + +Create a new firmware using new guid. + +### 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 ``` -## PARAMETERS - -### -Break -Wait forNET debugger to attach +```output +Description : description +FileName : FileName +FileSize : 1 +Id : +Model : model +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +ProvisioningState : +ResourceGroupName : +Status : +StatusMessage : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : microsoft.iotfirmwaredefense/workspaces/firmwares +Vendor : vendor +Version : version +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +Create a new firmware using a user specified firmwareId. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -107,36 +138,6 @@ Type: System.Int64 Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -154,7 +155,7 @@ Aliases: FirmwareId Required: False Position: Named -Default value: None +Default value: New-Guid Accept pipeline input: False Accept wildcard characters: False ``` @@ -174,28 +175,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -204,21 +190,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -252,7 +223,6 @@ Accept wildcard characters: False ### -StatusMessage A list of errors or other messages generated during firmware analysis -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IStatusMessage[] @@ -277,7 +247,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -366,17 +336,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmware -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -STATUSMESSAGE \: A list of errors or other messages generated during firmware analysis - \[ErrorCode \\]: The error code - \[Message \\]: The error or status message +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/new-azfirmwareanalysisfirmware](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/new-azfirmwareanalysisfirmware) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisWorkspace.md index 2782d614ff44..28b1065a2347 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisWorkspace.md @@ -14,9 +14,8 @@ The operation to Create a firmware analysis workspace. ``` New-AzFirmwareAnalysisWorkspace -Name -ResourceGroupName [-SubscriptionId ] - -Location [-Tag ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -Location [-Tag ] [-DefaultProfile ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -24,27 +23,30 @@ The operation to Create a firmware analysis workspace. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create a new firmware analysis workspace. +```powershell New-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name name -Location location ``` -## PARAMETERS +```output +Id : +Location : +Name : +ProvisioningState : +ResourceGroupName : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : {} +Type : microsoft.iotfirmwaredefense/workspaces +``` -### -Break -Wait forNET debugger to attach +Create a new firmware analysis workspace. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -62,36 +64,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Location The geo-location where the resource lives @@ -122,28 +94,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -152,21 +109,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -194,7 +136,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -253,9 +195,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IWorkspace + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/new-azfirmwareanalysisworkspace](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/new-azfirmwareanalysisworkspace) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisWorkspaceUploadUrl.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisWorkspaceUploadUrl.md index 86624c7cdde0..0aac19fc4d5d 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisWorkspaceUploadUrl.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/New-AzFirmwareAnalysisWorkspaceUploadUrl.md @@ -15,49 +15,42 @@ The operation to get a url for file upload. ### GenerateExpanded (Default) ``` New-AzFirmwareAnalysisWorkspaceUploadUrl -ResourceGroupName [-SubscriptionId ] - -WorkspaceName [-FirmwareId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -WorkspaceName [-FirmwareId ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### GenerateViaJsonString ``` New-AzFirmwareAnalysisWorkspaceUploadUrl -ResourceGroupName [-SubscriptionId ] - -WorkspaceName -JsonString [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -WorkspaceName -JsonString [-DefaultProfile ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### GenerateViaJsonFilePath ``` New-AzFirmwareAnalysisWorkspaceUploadUrl -ResourceGroupName [-SubscriptionId ] - -WorkspaceName -JsonFilePath [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -WorkspaceName -JsonFilePath [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### Generate ``` New-AzFirmwareAnalysisWorkspaceUploadUrl -ResourceGroupName [-SubscriptionId ] - -WorkspaceName -GenerateUploadUrl [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -WorkspaceName -GenerateUploadUrl [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### GenerateViaIdentityExpanded ``` New-AzFirmwareAnalysisWorkspaceUploadUrl -InputObject [-FirmwareId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### GenerateViaIdentity ``` New-AzFirmwareAnalysisWorkspaceUploadUrl -InputObject - -GenerateUploadUrl [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -GenerateUploadUrl [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -65,27 +58,20 @@ The operation to get a url for file upload. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create a url for file upload. +```powershell New-AzFirmwareAnalysisWorkspaceUploadUrl -ResourceGroupName resourceGroupName -WorkspaceName workspaceName -FirmwareId firmwareId ``` -## PARAMETERS - -### -Break -Wait forNET debugger to attach +```output +Url +--- +xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +Create a url for file upload. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -120,7 +106,6 @@ Accept wildcard characters: False ### -GenerateUploadUrl Properties for generating an upload URL -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IGenerateUploadUrlRequest @@ -134,39 +119,8 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -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 @@ -210,13 +164,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -225,36 +179,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -282,7 +206,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -339,30 +263,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity + ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IGenerateUploadUrlRequest + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IUrlToken -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -GENERATEUPLOADURL \: Properties for generating an upload URL - \[FirmwareId \\]: A unique ID for the firmware to be uploaded. - -INPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/new-azfirmwareanalysisworkspaceuploadurl](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/new-azfirmwareanalysisworkspaceuploadurl) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Remove-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Remove-AzFirmwareAnalysisFirmware.md index c7fcfced0275..d1576d21fd13 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Remove-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Remove-AzFirmwareAnalysisFirmware.md @@ -15,25 +15,21 @@ The operation to delete a firmware. ### Delete (Default) ``` Remove-AzFirmwareAnalysisFirmware -Id -ResourceGroupName [-SubscriptionId ] - -WorkspaceName [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -WorkspaceName [-DefaultProfile ] [-PassThru] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityWorkspace ``` Remove-AzFirmwareAnalysisFirmware -Id -WorkspaceInputObject - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### DeleteViaIdentity ``` Remove-AzFirmwareAnalysisFirmware -InputObject [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,27 +37,14 @@ The operation to delete a firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete a firmware analysis workspace. +```powershell Remove-AzFirmwareAnalysisFirmware -Id firmwareId -ResourceGroupName resourceGroupName -WorkspaceName workspaceName ``` -## PARAMETERS - -### -Break -Wait forNET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +Delete a firmware analysis workspace. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -79,36 +62,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Id The id of the firmware. @@ -126,7 +79,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -148,21 +100,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -170,13 +107,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -185,21 +122,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -227,14 +149,13 @@ Aliases: Required: False Position: Named -Default value: None +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 @@ -300,36 +221,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. - -WORKSPACEINPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/remove-azfirmwareanalysisfirmware](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/remove-azfirmwareanalysisfirmware) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Remove-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Remove-AzFirmwareAnalysisWorkspace.md index 58c0a9f141ed..d4f6a4b16291 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Remove-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Remove-AzFirmwareAnalysisWorkspace.md @@ -15,17 +15,14 @@ The operation to delete a firmware analysis workspace. ### Delete (Default) ``` Remove-AzFirmwareAnalysisWorkspace -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### DeleteViaIdentity ``` Remove-AzFirmwareAnalysisWorkspace -InputObject [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -33,27 +30,14 @@ The operation to delete a firmware analysis workspace. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete a firmware analysis workspace. +```powershell Remove-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName ``` -## PARAMETERS - -### -Break -Wait forNET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +Delete a firmware analysis workspace. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -71,39 +55,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -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 @@ -140,21 +93,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -162,13 +100,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -177,21 +115,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -219,7 +142,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -261,26 +184,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/remove-azfirmwareanalysisworkspace](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/remove-azfirmwareanalysisworkspace) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Update-AzFirmwareAnalysisFirmware.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Update-AzFirmwareAnalysisFirmware.md index 557d916c41db..e9ef62f94d8a 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Update-AzFirmwareAnalysisFirmware.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Update-AzFirmwareAnalysisFirmware.md @@ -17,9 +17,7 @@ The operation to update firmware. Update-AzFirmwareAnalysisFirmware -Id -ResourceGroupName [-SubscriptionId ] -WorkspaceName [-Description ] [-FileName ] [-FileSize ] [-Model ] [-Status ] [-StatusMessage ] [-Vendor ] [-Version ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityWorkspaceExpanded @@ -27,8 +25,7 @@ Update-AzFirmwareAnalysisFirmware -Id -ResourceGroupName [-Sub Update-AzFirmwareAnalysisFirmware -Id -WorkspaceInputObject [-Description ] [-FileName ] [-FileSize ] [-Model ] [-Status ] [-StatusMessage ] [-Vendor ] [-Version ] [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded @@ -36,8 +33,7 @@ Update-AzFirmwareAnalysisFirmware -Id -WorkspaceInputObject [-Description ] [-FileName ] [-FileSize ] [-Model ] [-Status ] [-StatusMessage ] [-Vendor ] [-Version ] [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,27 +41,36 @@ The operation to update firmware. ## EXAMPLES -### EXAMPLE 1 -``` +### 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 ``` -## PARAMETERS - -### -Break -Wait forNET debugger to attach +```output +Description : description +FileName : FileName +FileSize : 1 +Id : +Model : model +Name : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +ProvisioningState : +ResourceGroupName : +Status : +StatusMessage : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : microsoft.iotfirmwaredefense/workspaces/firmwares +Vendor : vendor +Version : version +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +Update a firmware. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -121,36 +126,6 @@ Type: System.Int64 Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -175,7 +150,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -204,13 +178,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -219,36 +193,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -282,7 +226,6 @@ Accept wildcard characters: False ### -StatusMessage A list of errors or other messages generated during firmware analysis -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IStatusMessage[] @@ -307,7 +250,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -344,7 +287,6 @@ Accept wildcard characters: False ### -WorkspaceInputObject Identity Parameter -. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity @@ -410,40 +352,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmware -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. - -STATUSMESSAGE \: A list of errors or other messages generated during firmware analysis - \[ErrorCode \\]: The error code - \[Message \\]: The error or status message - -WORKSPACEINPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/update-azfirmwareanalysisfirmware](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/update-azfirmwareanalysisfirmware) - diff --git a/src/FirmwareAnalysis/FirmwareAnalysis/help/Update-AzFirmwareAnalysisWorkspace.md b/src/FirmwareAnalysis/FirmwareAnalysis/help/Update-AzFirmwareAnalysisWorkspace.md index 6a73ae155062..2d46e82741e5 100644 --- a/src/FirmwareAnalysis/FirmwareAnalysis/help/Update-AzFirmwareAnalysisWorkspace.md +++ b/src/FirmwareAnalysis/FirmwareAnalysis/help/Update-AzFirmwareAnalysisWorkspace.md @@ -15,16 +15,13 @@ The operation to update a firmware analysis workspaces. ### UpdateExpanded (Default) ``` Update-AzFirmwareAnalysisWorkspace -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzFirmwareAnalysisWorkspace -InputObject [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,27 +29,30 @@ The operation to update a firmware analysis workspaces. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update a firmware analysis workspace. +```powershell Update-AzFirmwareAnalysisWorkspace -ResourceGroupName resourceGroupName -Name workspaceName ``` -## PARAMETERS +```output +Id : +Location : +Name : +ProvisioningState : +ResourceGroupName : +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : {} +Type : microsoft.iotfirmwaredefense/workspaces +``` -### -Break -Wait forNET debugger to attach +Update a firmware analysis workspace. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -70,39 +70,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -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 @@ -131,28 +100,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -161,21 +115,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -203,7 +142,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -245,26 +184,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IFirmwareAnalysisIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.FirmwareAnalysis.Models.IWorkspace -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[FirmwareId \\]: The id of the firmware. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - \[SummaryName \\]: The Firmware analysis summary name describing the type of summary. - \[WorkspaceName \\]: The name of the firmware analysis workspace. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.firmwareanalysis/update-azfirmwareanalysisworkspace](https://learn.microsoft.com/powershell/module/az.firmwareanalysis/update-azfirmwareanalysisworkspace) -