Share via

az firmwareanalysis workspace

  • 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 workspace command. Learn more about extensions.

Commands to perform operation on a particular workspace of the firmware.

Commands

Name Description Type Status
az firmwareanalysis workspace create

Create or update a firmware analysis workspace.

 Extension GA
az firmwareanalysis workspace delete

Delete a firmware analysis workspace.

 Extension GA
az firmwareanalysis workspace generate-upload-url

Get a url for file upload.

 Extension GA
az firmwareanalysis workspace list

List all of the firmware analysis workspaces in the specified subscription.

 Extension GA
az firmwareanalysis workspace show

Get firmware analysis workspace.

 Extension GA

az firmwareanalysis workspace create

Create or update a firmware analysis workspace.

az firmwareanalysis workspace create --name
                                     --resource-group
                                     [--location]
                                     [--tags]

Examples

create or update a firmware analysis workspace.

az firmwareanalysis workspace create --resource-group {resourceGroupName} --workspace-name {workspaceName} --location {location} --tags {<string>:<string>, <string>:<string>,..}

Required Parameters

--name --workspace-name -n

The name of the firmware analysis workspace.

--resource-group -g

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

Optional Parameters

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 workspace delete

Delete a firmware analysis workspace.

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

Examples

Delete a firmware analysis workspace.

az firmwareanalysis workspace delete --resource-group {resourceGroupName} --workspace-name {workspaceName}

Optional Parameters

--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 --workspace-name -n

The name of the firmware analysis workspace.

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

--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 workspace generate-upload-url

Get a url for file upload.

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

Examples

Get a url for file upload.

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

Optional Parameters

--firmware-id

A unique ID for the firmware to be uploaded.

--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 workspace list

List all of the firmware analysis workspaces in the specified subscription.

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

Examples

List all of the firmware analysis workspaces in the specified subscription.

az firmwareanalysis workspace list --resource-group {ResourceGroupName}

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.

--resource-group -g

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

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 workspace show

Get firmware analysis workspace.

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

Examples

Get firmware analysis workspace.

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

Optional Parameters

--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 --workspace-name -n

The name of the firmware analysis workspace.

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

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.