az firmwareanalysis firmware

  • Reference

Note

This reference is part of the firmwareanalysis extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az firmwareanalysis firmware command. Learn more about extensions.

Commands to perform operation on a particular firmware.

Commands

Name Description Type Status
az firmwareanalysis firmware binary-hardening

List binary hardening analysis results of a firmware.

 Extension GA
az firmwareanalysis firmware create

Create a new firmware.

 Extension GA
az firmwareanalysis firmware crypto-certificate

List cryptographic certificate analysis results found in a firmware.

 Extension GA
az firmwareanalysis firmware crypto-key

List cryptographic key analysis results found in a firmware.

 Extension GA
az firmwareanalysis firmware cve

List CVE analysis results of a firmware.

 Extension GA
az firmwareanalysis firmware delete

Delete a firmware.

 Extension GA
az firmwareanalysis firmware generate-filesystem-download-url

Get a url for tar file download.

 Extension GA
az firmwareanalysis firmware list

List all the firmware images inside a workspace.

 Extension GA
az firmwareanalysis firmware password-hash

List password hash analysis results of a firmware.

 Extension GA
az firmwareanalysis firmware sbom-component

List SBOM analysis results of a firmware.

 Extension GA
az firmwareanalysis firmware show

Get a firmware.

 Extension GA
az firmwareanalysis firmware summary

Get an analysis result summary of a firmware by name.

 Extension GA

az firmwareanalysis firmware binary-hardening

List binary hardening analysis results of a firmware.

az firmwareanalysis firmware binary-hardening --firmware-id
                                              --resource-group
                                              --workspace-name
                                              [--max-items]
                                              [--next-token]

Examples

List binary hardening analysis results of a firmware.

az firmwareanalysis firmware binary-hardening --resource-group {ResourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId}

Required Parameters

--firmware-id

The id of the firmware.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the firmware analysis workspace.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware create

Create a new firmware.

az firmwareanalysis firmware create --resource-group
                                    --workspace-name
                                    [--description]
                                    [--file-name]
                                    [--file-size]
                                    [--firmware-id]
                                    [--model]
                                    [--status {Analyzing, Error, Extracting, Pending, Ready}]
                                    [--status-messages]
                                    [--vendor]
                                    [--version]

Examples

Create a new firmware.

az firmwareanalysis firmware create --resource-group {resourceGroupName} --workspace-name {workspaceName} --description {description} --file-name {fileName} --file-size {fileSize} --vendor {vendorName} --model {model} --version {version} --status {status} --status-messages ['hi','message']

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the firmware analysis workspace.

Optional Parameters

--description

User-specified description of the firmware.

--file-name

File name for a firmware that user uploaded.

--file-size

File size of the uploaded firmware image.

--firmware-id --name -n

The id of the firmware.

Default value: 638bf535-bc2a-4acc-847d-71f2d1455b78
--model

Firmware model.

--status

The status of firmware scan.

Accepted values: Analyzing, Error, Extracting, Pending, Ready
Default value: Pending
--status-messages

A list of errors or other messages generated during firmware analysis Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--vendor

Firmware vendor.

--version

Firmware version.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware crypto-certificate

List cryptographic certificate analysis results found in a firmware.

az firmwareanalysis firmware crypto-certificate --firmware-id
                                                --resource-group
                                                --workspace-name
                                                [--max-items]
                                                [--next-token]

Examples

List cryptographic certificate analysis results found in a firmware.

az firmwareanalysis firmware crypto-certificate --resource-group {ResourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId}

Required Parameters

--firmware-id

The id of the firmware.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the firmware analysis workspace.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware crypto-key

List cryptographic key analysis results found in a firmware.

az firmwareanalysis firmware crypto-key --firmware-id
                                        --resource-group
                                        --workspace-name
                                        [--max-items]
                                        [--next-token]

Examples

List cryptographic key analysis results found in a firmware.

az firmwareanalysis firmware crypto-key --resource-group {ResourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId}

Required Parameters

--firmware-id

The id of the firmware.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the firmware analysis workspace.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware cve

List CVE analysis results of a firmware.

az firmwareanalysis firmware cve --firmware-id
                                 --resource-group
                                 --workspace-name
                                 [--max-items]
                                 [--next-token]

Examples

List CVE analysis results of a firmware.

az az firmwareanalysis firmware cve --resource-group {ResourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId}

Required Parameters

--firmware-id

The id of the firmware.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the firmware analysis workspace.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware delete

Delete a firmware.

az firmwareanalysis firmware delete [--firmware-id]
                                    [--ids]
                                    [--resource-group]
                                    [--subscription]
                                    [--workspace-name]
                                    [--yes]

Examples

Delete a firmware.

az firmwareanalysis firmware delete --resource-group {ResourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId}

Optional Parameters

--firmware-id --name -n

The id of the firmware.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The name of the firmware analysis workspace.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware generate-filesystem-download-url

Get a url for tar file download.

az firmwareanalysis firmware generate-filesystem-download-url [--firmware-id]
                                                              [--ids]
                                                              [--resource-group]
                                                              [--subscription]
                                                              [--workspace-name]

Examples

Get a url for tar file download.

az firmwareanalysis firmware generate-filesystem-download-url --resource-group {ResourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId}

Optional Parameters

--firmware-id

The id of the firmware.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The name of the firmware analysis workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware list

List all the firmware images inside a workspace.

az firmwareanalysis firmware list --resource-group
                                  --workspace-name
                                  [--max-items]
                                  [--next-token]

Examples

List all the firmware images inside a workspace.

az firmwareanalysis firmware show --resource-group {ResourceGroupName} --workspace-name {workspaceName}

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the firmware analysis workspace.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware password-hash

List password hash analysis results of a firmware.

az firmwareanalysis firmware password-hash --firmware-id
                                           --resource-group
                                           --workspace-name
                                           [--max-items]
                                           [--next-token]

Examples

List password hash analysis results of a firmware.

az firmwareanalysis firmware password-hash --resource-group {ResourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId}

Required Parameters

--firmware-id

The id of the firmware.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the firmware analysis workspace.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware sbom-component

List SBOM analysis results of a firmware.

az firmwareanalysis firmware sbom-component --firmware-id
                                            --resource-group
                                            --workspace-name
                                            [--max-items]
                                            [--next-token]

Examples

List SBOM analysis results of a firmware.

az firmwareanalysis firmware sbom-component --resource-group {ResourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId}

Required Parameters

--firmware-id

The id of the firmware.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the firmware analysis workspace.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware show

Get a firmware.

az firmwareanalysis firmware show [--firmware-id]
                                  [--ids]
                                  [--resource-group]
                                  [--subscription]
                                  [--workspace-name]

Examples

Get a firmware.

az firmwareanalysis firmware show --resource-group {ResourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId}

Optional Parameters

--firmware-id --name -n

The id of the firmware.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The name of the firmware analysis workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az firmwareanalysis firmware summary

Get an analysis result summary of a firmware by name.

az firmwareanalysis firmware summary [--firmware-id]
                                     [--ids]
                                     [--name {BinaryHardening, CVE, CryptoCertificate, CryptoKey, Firmware}]
                                     [--resource-group]
                                     [--subscription]
                                     [--workspace-name]

Examples

Get an analysis result summary of a firmware by name.

az firmwareanalysis firmware summary --resource-group {resourceGroupName} --workspace-name {workspaceName} --firmware-id {firmwareId} -n {analysisType}

Optional Parameters

--firmware-id

The id of the firmware.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --summary-name -n

The Firmware analysis summary name describing the type of summary.

Accepted values: BinaryHardening, CVE, CryptoCertificate, CryptoKey, Firmware
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The name of the firmware analysis workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.