Share via

az workload-orchestration configuration

Note

This reference is part of the workload-orchestration extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az workload-orchestration configuration command. Learn more about extensions.

Workload-orchestration configuration helps to manage configurations.

Commands

Name Description Type Status
az workload-orchestration configuration download

Download configurations available at specified hierarchical entity.

 Extension GA
az workload-orchestration configuration set

To set the values to configurations available at specified hierarchical entity.

 Extension GA
az workload-orchestration configuration show

To get a configurations available at specified hierarchical entity.

 Extension GA

az workload-orchestration configuration download

Download configurations available at specified hierarchical entity.

az workload-orchestration configuration download [--ids]
                                                 [--resource-group]
                                                 [--solution-template-name]
                                                 [--subscription]
                                                 [--target-name]

Examples

Download configuration

az workload-orchestration configuration download -g rg1 --target-name target1 --solution-template-name solutionTemplate1

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
--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
--solution-template-name

The name of the DynamicConfiguration.

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
--target-name

The name of the Configuration.

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 workload-orchestration configuration set

To set the values to configurations available at specified hierarchical entity.

az workload-orchestration configuration set --resource-group
                                            --target-name
                                            [--file]
                                            [--solution-template-name]

Examples

Set a Configuration through editor

az workload-orchestration configuration set -g rg1 --target-name target1 --solution-template-name solutionTemplate1

Set a Configuration through file

az workload-orchestration configuration set -g rg1 --target-name target1 --solution-template-name solutionTemplate1 --file /path/to/config.yaml

Required Parameters

--resource-group -g

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

--target-name

The Deployment Target or Site name at which values needs to be set.

Optional Parameters

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

--file -f

Path to a file containing the configuration values. If provided, the editor will not be opened.

--solution-template-name

The name of the Solution, This is required only to set solution configurations.

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 workload-orchestration configuration show

To get a configurations available at specified hierarchical entity.

az workload-orchestration configuration show --target-name
                                             [--ids]
                                             [--resource-group]
                                             [--solution-template-name]
                                             [--subscription]
                                             [--version]

Examples

Show a Configuration

az workload-orchestration configuration show -g rg1 --target-name target1 --solution-template-name solutionTemplate1

Required Parameters

--target-name

The Target or Site name at which values needs to be set.

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
--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
--solution-template-name

The name of the Solution, This is required only to get solution configurations.

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

The version of the solution to show configuration for. Defaults to 'version1' if not specified.

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