az workload-orchestration solution-template

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 solution-template helps to manage Solution Templates.

Commands

Name Description Type Status
az workload-orchestration solution-template bulk-deploy (workload-orchestration extension)

Post request for bulk deploy.

 Extension GA
az workload-orchestration solution-template bulk-deploy (workload-orchestration-preview extension)

Post request for bulk deploy.

 Extension GA
az workload-orchestration solution-template bulk-publish (workload-orchestration extension)

Post request for bulk publish.

 Extension GA
az workload-orchestration solution-template bulk-publish (workload-orchestration-preview extension)

Post request for bulk publish.

 Extension GA
az workload-orchestration solution-template bulk-review (workload-orchestration extension)

Post request for bulk review.

 Extension GA
az workload-orchestration solution-template bulk-review (workload-orchestration-preview extension)

Post request for bulk review.

 Extension GA
az workload-orchestration solution-template create (workload-orchestration extension)

Create a Solution Template Resource.

 Extension GA
az workload-orchestration solution-template create (workload-orchestration-preview extension)

Create a Solution Template Resource.

 Extension GA
az workload-orchestration solution-template delete (workload-orchestration extension)

Delete a Solution Template Resource.

 Extension GA
az workload-orchestration solution-template delete (workload-orchestration-preview extension)

Delete a Solution Template Resource.

 Extension GA
az workload-orchestration solution-template list (workload-orchestration extension)

List by specified resource group.

 Extension GA
az workload-orchestration solution-template list (workload-orchestration-preview extension)

List by specified resource group.

 Extension GA
az workload-orchestration solution-template list-subscriptions (workload-orchestration extension)

List by subscription.

 Extension GA
az workload-orchestration solution-template list-subscriptions (workload-orchestration-preview extension)

List by subscription.

 Extension GA
az workload-orchestration solution-template remove-version (workload-orchestration extension)

Remove Solution Template Version Resource.

 Extension GA
az workload-orchestration solution-template remove-version (workload-orchestration-preview extension)

Remove Solution Template Version Resource.

 Extension GA
az workload-orchestration solution-template show (workload-orchestration extension)

Get a Solution Template Resource.

 Extension GA
az workload-orchestration solution-template show (workload-orchestration-preview extension)

Get a Solution Template Resource.

 Extension GA
az workload-orchestration solution-template update-capabilities (workload-orchestration extension)

Update the capabilities of a Solution Template Resource.

 Extension GA
az workload-orchestration solution-template update-capabilities (workload-orchestration-preview extension)

Update the capabilities of 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 (workload-orchestration extension)

List Solution Template Version Resources.

 Extension GA
az workload-orchestration solution-template version list (workload-orchestration-preview extension)

List Solution Template Version Resources.

 Extension GA
az workload-orchestration solution-template version show (workload-orchestration extension)

Get a Solution Template Version Resource.

 Extension GA
az workload-orchestration solution-template version show (workload-orchestration-preview extension)

Get a Solution Template Version Resource.

 Extension GA
az workload-orchestration solution-template wait (workload-orchestration extension)

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

 Extension GA
az workload-orchestration solution-template wait (workload-orchestration-preview extension)

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

 Extension GA

az workload-orchestration solution-template bulk-deploy (workload-orchestration extension)

Post request for bulk deploy.

az workload-orchestration solution-template bulk-deploy --targets
                                                        [--acquire-policy-token]
                                                        [--change-reference]
                                                        [--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.

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

Post request for bulk deploy.

az workload-orchestration solution-template bulk-deploy --targets
                                                        [--acquire-policy-token]
                                                        [--change-reference]
                                                        [--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.

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

Post request for bulk publish.

az workload-orchestration solution-template bulk-publish --targets
                                                         [--acquire-policy-token]
                                                         [--change-reference]
                                                         [--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.

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

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

Post request for bulk publish.

az workload-orchestration solution-template bulk-publish --targets
                                                         [--acquire-policy-token]
                                                         [--change-reference]
                                                         [--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.

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

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

Post request for bulk review.

az workload-orchestration solution-template bulk-review --targets
                                                        [--acquire-policy-token]
                                                        [--change-reference]
                                                        [--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.

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

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

Property Value
Parameter group: Body Arguments
--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-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 bulk-review (workload-orchestration-preview extension)

Post request for bulk review.

az workload-orchestration solution-template bulk-review --targets
                                                        [--acquire-policy-token]
                                                        [--change-reference]
                                                        [--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.

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

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

Property Value
Parameter group: Body Arguments
--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-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 (workload-orchestration extension)

Create a Solution Template Resource.

az workload-orchestration solution-template create --capabilities
                                                   --config-template-file --configuration-template-file
                                                   --description
                                                   --resource-group
                                                   --specification
                                                   [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--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.

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

Create a Solution Template Resource.

az workload-orchestration solution-template create --capabilities
                                                   --description
                                                   --resource-group
                                                   --specification
                                                   [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--config-template-file --configuration-template-file]
                                                   [--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
--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.

--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
--config-template-file --configuration-template-file -f

Link to File containing Config expressions for this solution version.

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

Delete a Solution Template Resource.

az workload-orchestration solution-template delete [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--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.

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

Delete a Solution Template Resource.

az workload-orchestration solution-template delete [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--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.

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

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

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

List by subscription.

az workload-orchestration solution-template list-subscriptions [--acquire-policy-token]
                                                               [--change-reference]
                                                               [--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.

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

List by subscription.

az workload-orchestration solution-template list-subscriptions [--acquire-policy-token]
                                                               [--change-reference]
                                                               [--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.

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

Remove Solution Template Version Resource.

az workload-orchestration solution-template remove-version --version
                                                           [--acquire-policy-token]
                                                           [--change-reference]
                                                           [--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.

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

Remove Solution Template Version Resource.

az workload-orchestration solution-template remove-version --version
                                                           [--acquire-policy-token]
                                                           [--change-reference]
                                                           [--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.

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

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

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

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

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

Update the capabilities of a Solution Template Resource.

az workload-orchestration solution-template update-capabilities --capabilities
                                                                --description
                                                                --name --solution-template-name
                                                                --resource-group
                                                                [--acquire-policy-token]
                                                                [--change-reference]
                                                                [--location]
                                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Update Solution Template Capabilities

az workload-orchestration solution-template update-capabilities -n mySolutionTemplate --capabilities "capability1" "capability2" "capability3" --location eastus --resource-group myResourceGroup

Required Parameters

--capabilities

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

Property Value
Parameter group: Properties Arguments
--description

Description of Solution template.

Property Value
Parameter group: Properties Arguments
--name --solution-template-name -n

The name of the SolutionTemplate.

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

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

Update the capabilities of a Solution Template Resource.

az workload-orchestration solution-template update-capabilities --capabilities
                                                                --description
                                                                --name --solution-template-name
                                                                --resource-group
                                                                [--acquire-policy-token]
                                                                [--change-reference]
                                                                [--location]
                                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Update Solution Template Capabilities

az workload-orchestration solution-template update-capabilities -n mySolutionTemplate --capabilities "capability1" "capability2" "capability3" --location eastus --resource-group myResourceGroup

Required Parameters

--capabilities

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

Property Value
Parameter group: Properties Arguments
--description

Description of Solution template.

Property Value
Parameter group: Properties Arguments
--name --solution-template-name -n

The name of the SolutionTemplate.

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

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

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

az workload-orchestration solution-template wait [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--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.

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

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

az workload-orchestration solution-template wait (workload-orchestration-preview extension)

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

az workload-orchestration solution-template wait [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--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.

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

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