az workload-orchestration configuration

Note

This command group has commands that are defined in two or more extensions. Each extension will automatically install the first time you run an extension command. Learn more about extensions.

Workload-orchestration configuration helps to manage configurations.

Commands

Name	Description	Type	Status
az workload-orchestration configuration download (workload-orchestration extension)	Download configurations available at specified hierarchical entity.	Extension	GA
az workload-orchestration configuration download (workload-orchestration-preview extension)	Download configurations available at specified hierarchical entity.	Extension	GA
az workload-orchestration configuration schema		Extension	GA
az workload-orchestration configuration schema show (workload-orchestration extension)	Show the schema placeholder for a configuration template or solution template.	Extension	GA
az workload-orchestration configuration schema show (workload-orchestration-preview extension)	Show the schema placeholder for a configuration template or solution template.	Extension	GA
az workload-orchestration configuration set (workload-orchestration extension)	To set the values to configurations available at specified hierarchical entity.	Extension	GA
az workload-orchestration configuration set (workload-orchestration-preview extension)	To set the values to configurations available at specified hierarchical entity.	Extension	GA
az workload-orchestration configuration show (workload-orchestration extension)	To get a configurations available at specified hierarchical entity.	Extension	GA
az workload-orchestration configuration show (workload-orchestration-preview extension)	To get a configurations available at specified hierarchical entity.	Extension	GA

az workload-orchestration configuration download (workload-orchestration extension)

Download configurations available at specified hierarchical entity.

az workload-orchestration configuration download --hierarchy-id
                                                 --template-name
                                                 --template-rg
                                                 --version
                                                 [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--solution {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--template-subscription]

Examples

Download configuration

az workload-orchestration configuration download --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0

Download a Solution Template Configuration

az workload-orchestration configuration download --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name solutionTemplate1 --version 1.0.0 --solution

Required Parameters

--hierarchy-id

The ARM ID for the target or site at which values needs to be downloaded.

--template-name -n

The name of the Template (Solution template or Configuration template) to download.

--template-rg -g

Resource group name for the template.

--version -v

Version of the template.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--solution

Flag to indicate that we are downloading a solution. If not provided, we are downloading a config template.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--template-subscription

Subscription ID for the template. Only needed if the subscription ID for the template is different than the current subscription ID.

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 download (workload-orchestration-preview extension)

Download configurations available at specified hierarchical entity.

az workload-orchestration configuration download --hierarchy-id
                                                 --template-name
                                                 --template-rg
                                                 --version
                                                 [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--solution {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--template-subscription]

Examples

Download configuration

az workload-orchestration configuration download --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0

Download a Solution Template Configuration

az workload-orchestration configuration download --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name solutionTemplate1 --version 1.0.0 --solution

Required Parameters

--hierarchy-id

The ARM ID for the target or site at which values needs to be downloaded.

--template-name -n

The name of the Template (Solution template or Configuration template) to download.

--template-rg -g

Resource group name for the template.

--version -v

Version of the template.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--solution

Flag to indicate that we are downloading a solution. If not provided, we are downloading a config template.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--template-subscription

Subscription ID for the template. Only needed if the subscription ID for the template is different than the current subscription ID.

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 set (workload-orchestration extension)

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

az workload-orchestration configuration set --hierarchy-id
                                            --template-name
                                            --template-rg
                                            --version
                                            [--acquire-policy-token]
                                            [--change-reference]
                                            [--file]
                                            [--solution {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--template-subscription]

Examples

Set a Configuration through editor

az workload-orchestration configuration set --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0

Set a Configuration through file

az workload-orchestration configuration set --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0 --file /path/to/config.yaml

Set a Solution Template Configuration

az workload-orchestration configuration set --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name solutionTemplate1 --version 1.0.0 --solution

Required Parameters

--hierarchy-id

The ARM ID for the target or site at which values needs to be set.

--template-name -n

The name of the Template (Solution template or Configuration template) to configure.

--template-rg -g

Resource group name for the template.

--version -v

Version of the template.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--file -f

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

--solution

Flag to indicate that we are configuring a solution. If not provided, we are configuring a config template.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--template-subscription

Subscription ID for the template. Only needed if the subscription ID for the template is different than the current subscription ID.

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 set (workload-orchestration-preview extension)

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

az workload-orchestration configuration set --hierarchy-id
                                            --template-name
                                            --template-rg
                                            --version
                                            [--acquire-policy-token]
                                            [--change-reference]
                                            [--file]
                                            [--solution {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--template-subscription]

Examples

Set a Configuration through editor

az workload-orchestration configuration set --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0

Set a Configuration through file

az workload-orchestration configuration set --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0 --file /path/to/config.yaml

Set a Solution Template Configuration

az workload-orchestration configuration set --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name solutionTemplate1 --version 1.0.0 --solution

Required Parameters

--hierarchy-id

The ARM ID for the target or site at which values needs to be set.

--template-name -n

The name of the Template (Solution template or Configuration template) to configure.

--template-rg -g

Resource group name for the template.

--version -v

Version of the template.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--file -f

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

--solution

Flag to indicate that we are configuring a solution. If not provided, we are configuring a config template.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--template-subscription

Subscription ID for the template. Only needed if the subscription ID for the template is different than the current subscription ID.

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 (workload-orchestration extension)

To get a configurations available at specified hierarchical entity.

az workload-orchestration configuration show --hierarchy-id
                                             --template-name
                                             --template-rg
                                             --version
                                             [--solution {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--template-subscription]

Examples

Show a Configuration

az workload-orchestration configuration show --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0

Show a Solution Template Configuration

az workload-orchestration configuration show --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name solutionTemplate1 --version 1.0.0 --solution

Required Parameters

--hierarchy-id

The ARM ID for the target or site at which values needs to be shown.

--template-name -n

The name of the Template (Solution template or Configuration template) to show.

--template-rg -g

Resource group name for the template.

--version -v

Version of the template.

Optional Parameters

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

--solution

Flag to indicate that we are showing a solution. If not provided, we are showing a config template.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--template-subscription

Subscription ID for the template. Only needed if the subscription ID for the template is different than the current subscription ID.

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 (workload-orchestration-preview extension)

To get a configurations available at specified hierarchical entity.

az workload-orchestration configuration show --hierarchy-id
                                             --template-name
                                             --template-rg
                                             --version
                                             [--solution {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--template-subscription]

Examples

Show a Configuration

az workload-orchestration configuration show --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name template1 --version 1.0.0

Show a Solution Template Configuration

az workload-orchestration configuration show --hierarchy-id "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --template-rg rg1 --template-name solutionTemplate1 --version 1.0.0 --solution

Required Parameters

--hierarchy-id

The ARM ID for the target or site at which values needs to be shown.

--template-name -n

The name of the Template (Solution template or Configuration template) to show.

--template-rg -g

Resource group name for the template.

--version -v

Version of the template.

Optional Parameters

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

--solution

Flag to indicate that we are showing a solution. If not provided, we are showing a config template.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--template-subscription

Subscription ID for the template. Only needed if the subscription ID for the template is different than the current subscription ID.

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

Feedback

Was this page helpful?