az workload-orchestration solution-template

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 solution-template command. Learn more about extensions.

Workload-orchestration solution-template helps to manage Solution Templates.

Commands

Name	Description	Type	Status
az workload-orchestration solution-template bulk-deploy	Post request for bulk deploy.	Extension	GA
az workload-orchestration solution-template bulk-publish	Post request for bulk publish.	Extension	GA
az workload-orchestration solution-template bulk-review	Post request for bulk review.	Extension	GA
az workload-orchestration solution-template create	Create a Solution Template Resource.	Extension	GA
az workload-orchestration solution-template delete	Delete a Solution Template Resource.	Extension	GA
az workload-orchestration solution-template list	List by specified resource group.	Extension	GA
az workload-orchestration solution-template list-subscriptions	List by subscription.	Extension	GA
az workload-orchestration solution-template remove-version	Remove Solution Template Version Resource.	Extension	GA
az workload-orchestration solution-template show	Get a Solution Template Resource.	Extension	GA
az workload-orchestration solution-template version	Manage solution template versions in workload orchestration.	Extension	GA
az workload-orchestration solution-template version list	List Solution Template Version Resources.	Extension	GA
az workload-orchestration solution-template version show	Get a Solution Template Version Resource.	Extension	GA
az workload-orchestration solution-template wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az workload-orchestration solution-template bulk-deploy

Post request for bulk deploy.

az workload-orchestration solution-template bulk-deploy --targets
                                                        [--ids]
                                                        [--name --solution-template-name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--resource-group]
                                                        [--solution-template-version --version]
                                                        [--subscription]

Examples

Create a BulkDeploySolution

az workload-orchestration solution-template bulk-deploy --targets "@targets.json" --name "<solution-template-name>" --version "<solution-template-version>" -g <rg>

Required Parameters

--targets

Targets to which solution needs to be deployed. Each target must contain solution-version-id. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

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

The name of the SolutionTemplate.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

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

The name of the SolutionTemplateVersion.

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 workload-orchestration solution-template bulk-publish

Post request for bulk publish.

az workload-orchestration solution-template bulk-publish --targets
                                                         [--configuration]
                                                         [--dependencies --solution-dependencies]
                                                         [--ids]
                                                         [--instance-name --solution-instance-name]
                                                         [--name --solution-template-name]
                                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                         [--resource-group]
                                                         [--solution-template-version --solution-template-version-name --version]
                                                         [--subscription]

Examples

Bulk publish solution for multiple targets.

az workload-orchestration solution-template bulk-publish --resource-group myResourceGroup --solution-template-name myTemplate --solution-template-version 1.0.0 --targets "@targets.json"

Required Parameters

--targets

Targets to which solution needs to be published Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

Optional Parameters

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

--configuration

Configuration of solution for the target/s.

Property	Value
Parameter group:	Body Arguments

--dependencies --solution-dependencies

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

Property	Value
Parameter group:	Body Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--instance-name --solution-instance-name

Name of the solution instance.

Property	Value
Parameter group:	Body Arguments

--name --solution-template-name -n

The name of the SolutionTemplate.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

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

The name of the SolutionTemplateVersion.

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 workload-orchestration solution-template bulk-review

Post request for bulk review.

az workload-orchestration solution-template bulk-review --targets
                                                        [--dependencies]
                                                        [--ids]
                                                        [--name --solution-template-name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--resource-group]
                                                        [--solution-configuration]
                                                        [--solution-instance-name]
                                                        [--solution-template-version --version]
                                                        [--subscription]

Examples

Bulk review solution for multiple targets.

az workload-orchestration solution-template bulk-review --resource-group myResourceGroup --solution-template-name myTemplate --solution-template-version 1.0.0 --targets "@targets.json"

Required Parameters

--targets

Targets to which solution needs to be published Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

Optional Parameters

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

--dependencies

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

Property	Value
Parameter group:	Body Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --solution-template-name -n

The name of the SolutionTemplate.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

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

Configuration of solution.

Property	Value
Parameter group:	Body Arguments

--solution-instance-name

Name of the solution instance.

Property	Value
Parameter group:	Body Arguments

--solution-template-version --version -v

The name of the SolutionTemplateVersion.

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 workload-orchestration solution-template create

Create a Solution Template Resource.

az workload-orchestration solution-template create --capabilities
                                                   --config-template-file --configuration-template-file
                                                   --description
                                                   --resource-group
                                                   --specification
                                                   [--enable-ext-validation --enable-external-validation {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--___location]
                                                   [--name --solution-template-name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--state {active, inactive}]
                                                   [--tags]
                                                   [--version]

Examples

Create Solution Template

az workload-orchestration solution-template create -n mySolutionTemplate --description "My Solution Template" --capabilities "capability1" --___location eastus --resource-group myResourceGroup --config-template-file ./solution_template.yaml --specification @./specification.json --enable-external-validation true

Required Parameters

--capabilities

List of capabilities Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--config-template-file --configuration-template-file -f

Link to File containing Config expressions for this solution version.

--description

Description of Solution template.

Property	Value
Parameter group:	Properties Arguments

--resource-group -g

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

--specification

App components spec, use @ to load from file Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

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

--enable-ext-validation --enable-external-validation

Flag to enable external validation.

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

--___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:	Resource Arguments

--name --solution-template-name -n

The name of the SolutionTemplate.

--no-wait

Do not wait for the long-running operation to finish.

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

--state

State of resource.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	active, inactive

--tags

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

Property	Value
Parameter group:	Resource Arguments

--version -v

Version of the solution template.

Property	Value
Parameter group:	Body 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 workload-orchestration solution-template delete

Delete a Solution Template Resource.

az workload-orchestration solution-template delete [--ids]
                                                   [--name --solution-template-name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--yes]

Examples

Delete a Solution Template

az workload-orchestration solution-template delete -n mySolutionTemplate -g 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

Property	Value
Parameter group:	Resource Id Arguments

--name --solution-template-name -n

The name of the SolutionTemplate.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

--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 workload-orchestration solution-template list

List by specified resource group.

az workload-orchestration solution-template list --resource-group
                                                 [--max-items]
                                                 [--next-token]

Examples

List Solution Templates

az workload-orchestration solution-template list -g myResourceGroup

Required Parameters

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

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

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 solution-template list-subscriptions

List by subscription.

az workload-orchestration solution-template list-subscriptions [--max-items]
                                                               [--next-token]
                                                               [--resource-group]

Examples

List Solution Templates

az workload-orchestration solution-template list-subscriptions

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

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 workload-orchestration solution-template remove-version

Remove Solution Template Version Resource.

az workload-orchestration solution-template remove-version --version
                                                           [--ids]
                                                           [--name --solution-template-name]
                                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                           [--resource-group]
                                                           [--subscription]

Examples

Remove a Solution Template Version

az workload-orchestration solution-template remove-version -n mySolutionTemplate -g myResourceGroup --version 1.0.0

Required Parameters

--version -v

Version of the Resource.

Property	Value
Parameter group:	Body Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--name --solution-template-name -n

The name of the SolutionTemplate.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

--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 workload-orchestration solution-template show

Get a Solution Template Resource.

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

Examples

Show a Solution Template

az workload-orchestration solution-template show -n mySolutionTemplate -g 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

Property	Value
Parameter group:	Resource Id Arguments

--name --solution-template-name -n

The name of the SolutionTemplate.

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 workload-orchestration solution-template wait

Place the CLI in a waiting state until a condition is met.

az workload-orchestration solution-template wait [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--ids]
                                                 [--interval]
                                                 [--name --solution-template-name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--timeout]
                                                 [--updated]

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --solution-template-name -n

The name of the SolutionTemplate.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
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

Feedback

Was this page helpful?

Share via

az workload-orchestration solution-template

Commands

az workload-orchestration solution-template bulk-deploy

Examples

Required Parameters

Optional Parameters

az workload-orchestration solution-template bulk-publish

Examples

Required Parameters

Optional Parameters

az workload-orchestration solution-template bulk-review

Examples

Required Parameters

Optional Parameters

az workload-orchestration solution-template create

Examples

Required Parameters

Optional Parameters

az workload-orchestration solution-template delete

Examples

Optional Parameters

az workload-orchestration solution-template list

Examples

Required Parameters

Optional Parameters

az workload-orchestration solution-template list-subscriptions

Examples

Optional Parameters

az workload-orchestration solution-template remove-version

Examples

Required Parameters

Optional Parameters

az workload-orchestration solution-template show

Examples

Optional Parameters

az workload-orchestration solution-template wait

Optional Parameters

Feedback