az quantum workspace keys

  • Preview
  • Reference

Note

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

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure Quantum Workspace api keys.

Commands

Name Description Type Status
az quantum workspace keys list

List api keys for the given (or current) Azure Quantum workspace.

 Extension Preview
az quantum workspace keys regenerate

Regenerate api key for the given (or current) Azure Quantum workspace.

 Extension Preview

az quantum workspace keys list

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List api keys for the given (or current) Azure Quantum workspace.

az quantum workspace keys list [--resource-group]
                               [--workspace-name]

Examples

Show the currently selected default Azure Quantum workspace api keys.

az quantum workspace keys list

Optional Parameters

--resource-group -g

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

--workspace-name -w

Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set.

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 quantum workspace keys regenerate

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Regenerate api key for the given (or current) Azure Quantum workspace.

az quantum workspace keys regenerate [--key-type]
                                     [--resource-group]
                                     [--workspace-name]

Examples

Regenerate the currently selected default Azure Quantum workspace primary api key.

az quantum workspace keys regenerate --key-type Primary

Regenerate the currently selected default Azure Quantum workspace secondary api key.

az quantum workspace keys regenerate --key-type Secondary

Regenerate the currently selected default Azure Quantum workspace secondary api key.

az quantum workspace keys regenerate --key-type Primary,Secondary

Optional Parameters

--key-type

The api keys to be regenerated, should be Primary and/or Secondary.

--resource-group -g

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

--workspace-name -w

Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set.

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.