az workload-orchestration solution-deployment

Note

This reference is part of the workload-orchestration-preview 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-deployment command. Learn more about extensions.

Workload-orchestration solution-deployment helps to manage Solution Deployments.

Commands

Name Description Type Status
az workload-orchestration solution-deployment create

Create or update a SolutionDeployment Resource.

 Extension GA
az workload-orchestration solution-deployment delete

Delete a SolutionDeployment Resource.

 Extension GA
az workload-orchestration solution-deployment list

List SolutionDeployment Resources.

 Extension GA
az workload-orchestration solution-deployment show

Get a SolutionDeployment Resource.

 Extension GA
az workload-orchestration solution-deployment wait

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

 Extension GA

az workload-orchestration solution-deployment create

Create or update a SolutionDeployment Resource.

az workload-orchestration solution-deployment create --name --solution-deployment-name
                                                     --resource-group
                                                     --solution-template-name
                                                     --solution-template-version
                                                     [--acquire-policy-token]
                                                     [--capabilities]
                                                     [--change-reference]
                                                     [--input]
                                                     [--location]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--solution-template-rg]
                                                     [--solution-template-subscription]
                                                     [--tags]
                                                     [--target-ids]

Examples

Create a Solution Deployment

az workload-orchestration solution-deployment create -g myResourceGroup -n mySolutionDeployment --location eastus --solution-template-name mySolutionTemplate --solution-template-version 1.0.0 --target-ids "/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Edge/targets/{target}"

Create a Solution Deployment with multiple targetIds

az workload-orchestration solution-deployment create -g myResourceGroup -n mySolutionDeployment --location eastus --solution-template-name mySolutionTemplate --solution-template-version 1.0.0 --target-ids "/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Edge/targets/{target1}" "/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Edge/targets/{target2}"

Required Parameters

--name --solution-deployment-name -n

The name of the SolutionDeployment.

--resource-group -g

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

--solution-template-name

Solution template name.

Property Value
Parameter group: SolutionTemplateProperties Arguments
--solution-template-version

Solution template version.

Property Value
Parameter group: SolutionTemplateProperties 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
--capabilities

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

Property Value
Parameter group: TargetProperties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--input

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

Property Value
Parameter group: Properties 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
--solution-template-rg

Solution template resource group.

Property Value
Parameter group: SolutionTemplateProperties Arguments
--solution-template-subscription

Solution template subscription.

Property Value
Parameter group: SolutionTemplateProperties Arguments
--tags

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

Property Value
Parameter group: Resource Arguments
--target-ids

ARM resource IDs of the Targets resources Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: TargetProperties 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-deployment delete

Delete a SolutionDeployment Resource.

az workload-orchestration solution-deployment delete [--acquire-policy-token]
                                                     [--change-reference]
                                                     [--ids]
                                                     [--name --solution-deployment-name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--yes]

Examples

Delete a Solution Deployment

az workload-orchestration solution-deployment delete -g myResourceGroup -n mySolutionDeployment

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

The name of the SolutionDeployment.

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

List SolutionDeployment Resources.

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

Examples

List Solution Deployments

az workload-orchestration solution-deployment list -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.

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

Get a SolutionDeployment Resource.

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

Examples

Show a Solution Deployment

az workload-orchestration solution-deployment show -n mySolutionDeployment -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-deployment-name -n

The name of the SolutionDeployment.

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

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

az workload-orchestration solution-deployment wait [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--created]
                                                   [--custom]
                                                   [--deleted]
                                                   [--exists]
                                                   [--ids]
                                                   [--interval]
                                                   [--name --solution-deployment-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-deployment-name -n

The name of the SolutionDeployment.

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