Share via


az firmwareanalysis workspace

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--___location -l

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

Property Value
Parameter group: Workspace Arguments
--tags

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

Property Value
Parameter group: Workspace Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az firmwareanalysis workspace delete

Delete a firmware analysis workspace.

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

Examples

Delete a firmware analysis workspace.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --workspace-name -n

The name of the firmware analysis workspace.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--firmware-id

A unique ID for the firmware to be uploaded.

Property Value
Parameter group: GenerateUploadUrl Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--workspace-name

The name of the firmware analysis workspace.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
--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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az firmwareanalysis workspace show

Get firmware analysis workspace.

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

Examples

Get firmware analysis workspace.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --workspace-name -n

The name of the firmware analysis workspace.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False