Get-AzFirmwareAnalysisSummary

Module:

Az.FirmwareAnalysis Module

Get an analysis result summary of a firmware by name.

Syntax

Get (Default)

Get-AzFirmwareAnalysisSummary
    -FirmwareId <String>
    -Name <String>
    -ResourceGroupName <String>
    -WorkspaceName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityWorkspace

Get-AzFirmwareAnalysisSummary
    -FirmwareId <String>
    -Name <String>
    -WorkspaceInputObject <IFirmwareAnalysisIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityFirmware

Get-AzFirmwareAnalysisSummary
    -Name <String>
    -FirmwareInputObject <IFirmwareAnalysisIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzFirmwareAnalysisSummary
    -InputObject <IFirmwareAnalysisIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get an analysis result summary of a firmware by name.

Examples

Example 1: List all the analysis results summary for a firmware by analysis type CVE.

Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Name Type

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.

Get-AzFirmwareAnalysisSummary -FirmwareId FirmwareId -ResourceGroupName ResourceGroupName -WorkspaceName WorkspaceName -Name Type

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 Firmware.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:	PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FirmwareId

The id of the firmware.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

GetViaIdentityWorkspace

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FirmwareInputObject

Identity Parameter

Parameter properties

Type:	IFirmwareAnalysisIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentityFirmware

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter

Parameter properties

Type:	IFirmwareAnalysisIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The Firmware analysis summary name describing the type of summary.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	SummaryName

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

GetViaIdentityWorkspace

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

GetViaIdentityFirmware

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:	String[]
Default value:	(Get-AzContext).Subscription.Id
Supports wildcards:	False
DontShow:	False

Parameter sets

Get

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceInputObject

Identity Parameter

Parameter properties

Type:	IFirmwareAnalysisIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentityWorkspace

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceName

The name of the firmware analysis workspace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IFirmwareAnalysisIdentity

Outputs

ISummaryResource