az workload-orchestration

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.

Manage workload orchestration resources.

Commands

Name Description Type Status
az workload-orchestration cluster

Prepare an Arc-connected Kubernetes cluster for Workload Orchestration.

Extension GA
az workload-orchestration cluster init (workload-orchestration extension)

Prepare an Arc-connected Kubernetes cluster for Workload Orchestration.

Extension GA
az workload-orchestration cluster init (workload-orchestration-preview extension)

Prepare an Arc-connected Kubernetes cluster for Workload Orchestration.

Extension GA
az workload-orchestration config-template

Workload-orchestration config-template helps to manage Config Templates.

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

Create a Config Template Resource.

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

Create a Config Template Resource.

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

Delete a Config Template Resource.

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

Delete a Config Template Resource.

Extension GA
az workload-orchestration config-template hierarchy

Workload-orchestration config-template hierarchy helps to manage config template hierarchies.

Extension GA
az workload-orchestration config-template hierarchy show (workload-orchestration extension)

Show linked hierarchies for a config template.

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

Show linked hierarchies for a config template.

Extension GA
az workload-orchestration config-template link (workload-orchestration extension)

Link a Config Template to hierarchies.

Extension GA
az workload-orchestration config-template link (workload-orchestration-preview extension)

Link a Config Template to hierarchies.

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

List by subscription.

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

List by subscription.

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

Remove Config Template Version Resource.

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

Remove Config Template Version Resource.

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

Get a Config Template Resource.

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

Get a Config Template Resource.

Extension GA
az workload-orchestration config-template unlink (workload-orchestration extension)

Unlink a Config Template from hierarchies.

Extension GA
az workload-orchestration config-template unlink (workload-orchestration-preview extension)

Unlink a Config Template from hierarchies.

Extension GA
az workload-orchestration config-template version

Manage workload orchestration config template versions.

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

List Config Template Version Resources.

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

List Config Template Version Resources.

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

Get a Config Template Version Resource.

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

Get a Config Template Version Resource.

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

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

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

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

Extension GA
az workload-orchestration configuration

Workload-orchestration configuration helps to manage configurations.

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

Download configurations available at specified hierarchical entity.

Extension GA
az workload-orchestration configuration download (workload-orchestration-preview extension)

Download configurations available at specified hierarchical entity.

Extension GA
az workload-orchestration configuration schema Extension GA
az workload-orchestration configuration schema show (workload-orchestration extension)

Show the schema placeholder for a configuration template or solution template.

Extension GA
az workload-orchestration configuration schema show (workload-orchestration-preview extension)

Show the schema placeholder for a configuration template or solution template.

Extension GA
az workload-orchestration configuration set (workload-orchestration extension)

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

Extension GA
az workload-orchestration configuration set (workload-orchestration-preview extension)

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

Extension GA
az workload-orchestration configuration show (workload-orchestration extension)

To get a configurations available at specified hierarchical entity.

Extension GA
az workload-orchestration configuration show (workload-orchestration-preview extension)

To get a configurations available at specified hierarchical entity.

Extension GA
az workload-orchestration context

Workload-orchestration context helps to manage contexts.

Extension GA
az workload-orchestration context add-capability (workload-orchestration extension)

Add capabilities to a context (idempotent).

Extension GA
az workload-orchestration context add-capability (workload-orchestration-preview extension)

Add capabilities to a context (idempotent).

Extension GA
az workload-orchestration context create (workload-orchestration extension)

Create Context Resource.

Extension GA
az workload-orchestration context create (workload-orchestration-preview extension)

Create Context Resource.

Extension GA
az workload-orchestration context current (workload-orchestration extension)

Show current context information.

Extension GA
az workload-orchestration context current (workload-orchestration-preview extension)

Show current context information.

Extension GA
az workload-orchestration context delete (workload-orchestration extension)

Delete Context Resource.

Extension GA
az workload-orchestration context delete (workload-orchestration-preview extension)

Delete Context Resource.

Extension GA
az workload-orchestration context list (workload-orchestration extension)

List by specified resource group.

Extension GA
az workload-orchestration context list (workload-orchestration-preview extension)

List by specified resource group.

Extension GA
az workload-orchestration context list-subscriptions (workload-orchestration extension)

List by subscription.

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

List by subscription.

Extension GA
az workload-orchestration context remove-capability (workload-orchestration extension)

Remove one or more capabilities from a context (idempotent).

Extension GA
az workload-orchestration context remove-capability (workload-orchestration-preview extension)

Remove one or more capabilities from a context (idempotent).

Extension GA
az workload-orchestration context set (workload-orchestration extension)

Set current context using context ID.

Extension GA
az workload-orchestration context set (workload-orchestration-preview extension)

Set current context using context ID.

Extension GA
az workload-orchestration context show (workload-orchestration extension)

Get Context Resource.

Extension GA
az workload-orchestration context show (workload-orchestration-preview extension)

Get Context Resource.

Extension GA
az workload-orchestration context site-reference

Manage workload orchestration site reference context.

Extension GA
az workload-orchestration context site-reference create (workload-orchestration extension)

Create Site Reference Resource.

Extension GA
az workload-orchestration context site-reference create (workload-orchestration-preview extension)

Create Site Reference Resource.

Extension GA
az workload-orchestration context site-reference delete (workload-orchestration extension)

Delete Site Reference Resource.

Extension GA
az workload-orchestration context site-reference delete (workload-orchestration-preview extension)

Delete Site Reference Resource.

Extension GA
az workload-orchestration context site-reference list (workload-orchestration extension)

List Site Reference Resources.

Extension GA
az workload-orchestration context site-reference list (workload-orchestration-preview extension)

List Site Reference Resources.

Extension GA
az workload-orchestration context site-reference show (workload-orchestration extension)

Get Site Reference Resource.

Extension GA
az workload-orchestration context site-reference show (workload-orchestration-preview extension)

Get Site Reference Resource.

Extension GA
az workload-orchestration context site-reference wait (workload-orchestration extension)

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

Extension GA
az workload-orchestration context site-reference wait (workload-orchestration-preview extension)

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

Extension GA
az workload-orchestration context use (workload-orchestration extension)

Use Context by name.

Extension GA
az workload-orchestration context use (workload-orchestration-preview extension)

Use Context by name.

Extension GA
az workload-orchestration context wait (workload-orchestration extension)

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

Extension GA
az workload-orchestration context wait (workload-orchestration-preview extension)

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

Extension GA
az workload-orchestration diagnostic

Workload-orchestration diagnostic helps to manage Diagnostics.

Extension GA
az workload-orchestration diagnostic create (workload-orchestration extension)

Create new or updates existing Diagnostic resource.

Extension GA
az workload-orchestration diagnostic create (workload-orchestration-preview extension)

Create new or updates existing Diagnostic resource.

Extension GA
az workload-orchestration diagnostic delete (workload-orchestration extension)

Delete specified Diagnostic resource.

Extension GA
az workload-orchestration diagnostic delete (workload-orchestration-preview extension)

Delete specified Diagnostic resource.

Extension GA
az workload-orchestration diagnostic list (workload-orchestration extension)

List Diagnostics resources within an Azure subscription.

Extension GA
az workload-orchestration diagnostic list (workload-orchestration-preview extension)

List Diagnostics resources within an Azure subscription.

Extension GA
az workload-orchestration diagnostic show (workload-orchestration extension)

Get details of specified Diagnostic resource.

Extension GA
az workload-orchestration diagnostic show (workload-orchestration-preview extension)

Get details of specified Diagnostic resource.

Extension GA
az workload-orchestration diagnostic update (workload-orchestration extension)

Update new or updates existing Diagnostic resource.

Extension GA
az workload-orchestration diagnostic update (workload-orchestration-preview extension)

Update new or updates existing Diagnostic resource.

Extension GA
az workload-orchestration diagnostic wait (workload-orchestration extension)

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

Extension GA
az workload-orchestration diagnostic wait (workload-orchestration-preview extension)

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

Extension GA
az workload-orchestration hierarchy

Manage workload-orchestration hierarchies (Site + Configuration + ConfigurationReference).

Extension GA
az workload-orchestration hierarchy create (workload-orchestration extension)

Create a hierarchy: Site + Configuration + ConfigurationReference (and ServiceGroup ancestors if type=ServiceGroup).

Extension GA
az workload-orchestration hierarchy create (workload-orchestration-preview extension)

Create a hierarchy: Site + Configuration + ConfigurationReference (and ServiceGroup ancestors if type=ServiceGroup).

Extension GA
az workload-orchestration schema

Workload-orchestration schema helps to manage Schemas.

Extension GA
az workload-orchestration schema create (workload-orchestration extension)

Create a Schema Resource.

Extension GA
az workload-orchestration schema create (workload-orchestration-preview extension)

Create a Schema Resource.

Extension GA
az workload-orchestration schema delete (workload-orchestration extension)

Delete a Schema Resource.

Extension GA
az workload-orchestration schema delete (workload-orchestration-preview extension)

Delete a Schema Resource.

Extension GA
az workload-orchestration schema list (workload-orchestration extension)

List by subscription.

Extension GA
az workload-orchestration schema list (workload-orchestration-preview extension)

List by subscription.

Extension GA
az workload-orchestration schema remove-version (workload-orchestration extension)

Remove Schema Version Resource.

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

Remove Schema Version Resource.

Extension GA
az workload-orchestration schema show (workload-orchestration extension)

Get a Schema Resource.

Extension GA
az workload-orchestration schema show (workload-orchestration-preview extension)

Get a Schema Resource.

Extension GA
az workload-orchestration schema version

Workload-orchestration schema version helps to manage Schemas.

Extension GA
az workload-orchestration schema version list (workload-orchestration extension)

List by specified resource group.

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

List by specified resource group.

Extension GA
az workload-orchestration schema version show (workload-orchestration extension)

Get a Schema Version Resource.

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

Get a Schema Version Resource.

Extension GA
az workload-orchestration schema version wait (workload-orchestration extension)

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

Extension GA
az workload-orchestration schema version wait (workload-orchestration-preview extension)

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

Extension GA
az workload-orchestration schema wait (workload-orchestration extension)

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

Extension GA
az workload-orchestration schema wait (workload-orchestration-preview extension)

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

Extension GA
az workload-orchestration solution-deployment

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

Extension GA
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-template

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

Extension GA
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 support

Commands for troubleshooting and diagnostics of workload orchestration deployments.

Extension Preview
az workload-orchestration support create-bundle (workload-orchestration extension)

Create a support bundle for troubleshooting workload orchestration issues.

Extension Preview
az workload-orchestration support create-bundle (workload-orchestration-preview extension)

Create a support bundle for troubleshooting workload orchestration issues.

Extension Preview
az workload-orchestration sync (workload-orchestration extension)

Sync workload orchestration resources for a custom location.

Extension GA
az workload-orchestration sync (workload-orchestration-preview extension)

Sync workload orchestration resources for a custom location.

Extension GA
az workload-orchestration target

Workload-orchestration target helps to manage Targets.

Extension GA
az workload-orchestration target create

Create a Target Resource.

Extension GA
az workload-orchestration target delete

Delete a Target Resource.

Extension GA
az workload-orchestration target install

Install a solution on a target.

Extension GA
az workload-orchestration target list

List by Resource-Group.

Extension GA
az workload-orchestration target list-subscriptions

List by subscription.

Extension GA
az workload-orchestration target publish

Post request to publish.

Extension GA
az workload-orchestration target remove-revision

Post request to remove solution version revision.

Extension GA
az workload-orchestration target review

Post request to review configuration.

Extension GA
az workload-orchestration target show

Get a Target Resource.

Extension GA
az workload-orchestration target solution-instance-list

List all solution instances of a solution deployed on a target.

Extension GA
az workload-orchestration target solution-revision-list

List all revisions of a solution deployed on a target.

Extension GA
az workload-orchestration target uninstall

Post request to uninstall.

Extension GA
az workload-orchestration target unstage

Unstage a Solution Version Resource.

Extension GA
az workload-orchestration target update

Update a Target Resource.

Extension GA
az workload-orchestration target update-external-validation-status

Post request to update external validation status.

Extension GA
az workload-orchestration target wait

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

Extension GA

az workload-orchestration sync (workload-orchestration extension)

Sync workload orchestration resources for a custom location.

az workload-orchestration sync --custom-location
                               [--acquire-policy-token]
                               [--change-reference]
                               [--local-connected-registry-ip]

Examples

Sync resources for a custom location

az workload-orchestration sync --custom-location /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/myCustomLocation

Required Parameters

--custom-location

The resource ID of the custom location.

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
--local-connected-registry-ip

IP address of the local connected registry on the new cluster. Not required if staging is not enabled for any solutions. If staging is enabled and this value is not provided, syncing those solutions will fail. When provided, the value is set in the configuration and a new revision for the solutions with staging enabled is installed.

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

Sync workload orchestration resources for a custom location.

az workload-orchestration sync --custom-location
                               [--acquire-policy-token]
                               [--change-reference]
                               [--local-connected-registry-ip]

Examples

Sync resources for a custom location

az workload-orchestration sync --custom-location /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/myCustomLocation

Required Parameters

--custom-location

The resource ID of the custom location.

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
--local-connected-registry-ip

IP address of the local connected registry on the new cluster. Not required if staging is not enabled for any solutions. If staging is enabled and this value is not provided, syncing those solutions will fail. When provided, the value is set in the configuration and a new revision for the solutions with staging enabled is installed.

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