Share via

az remote-rendering-account key

  • Preview

Note

This reference is part of the mixed-reality extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an az remote-rendering-account key command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage developer keys of a remote rendering account.

Commands

Name Description Type Status
az remote-rendering-account key renew

Regenerate specified Key of a Remote Rendering Account.

 Extension Preview
az remote-rendering-account key show

List Both of the 2 Keys of a Remote Rendering Account.

 Extension Preview

az remote-rendering-account key renew

Preview

Command group 'az remote-rendering-account key' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Regenerate specified Key of a Remote Rendering Account.

az remote-rendering-account key renew [--ids]
                                      [--key {primary, secondary}]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Examples

Regenerate remote rendering account keys

az remote-rendering-account key renew -n "MyAccount" -k primary --resource-group "MyResourceGroup"

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
--key -k

Key to be regenerated.

Property Value
Default value: primary
Accepted values: primary, secondary
--name -n

Name of an Mixed Reality Account.

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

az remote-rendering-account key show

Preview

Command group 'az remote-rendering-account key' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Both of the 2 Keys of a Remote Rendering Account.

az remote-rendering-account key show [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Examples

List remote rendering account key

az remote-rendering-account key show -n "MyAccount" --resource-group "MyResourceGroup"

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

Name of an Mixed Reality Account.

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