az workload-orchestration-preview

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

Manage workload orchestration resources.

Commands

Name Description Type Status
az workload-orchestration-preview cluster

Prepare an Arc-connected Kubernetes cluster for Workload Orchestration.

Extension GA
az workload-orchestration-preview cluster init

Prepare an Arc-connected Kubernetes cluster for Workload Orchestration.

Extension GA
az workload-orchestration-preview config-template

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

Extension GA
az workload-orchestration-preview config-template create

Create a Config Template Resource.

Extension GA
az workload-orchestration-preview config-template delete

Delete a Config Template Resource.

Extension GA
az workload-orchestration-preview config-template hierarchy

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

Extension GA
az workload-orchestration-preview config-template hierarchy show

Show linked hierarchies for a config template.

Extension GA
az workload-orchestration-preview config-template link

Link a Config Template to hierarchies.

Extension GA
az workload-orchestration-preview config-template list

List by subscription.

Extension GA
az workload-orchestration-preview config-template remove-version

Remove Config Template Version Resource.

Extension GA
az workload-orchestration-preview config-template show

Get a Config Template Resource.

Extension GA
az workload-orchestration-preview config-template unlink

Unlink a Config Template from hierarchies.

Extension GA
az workload-orchestration-preview config-template version

Manage workload orchestration config template versions.

Extension GA
az workload-orchestration-preview config-template version list

List Config Template Version Resources.

Extension GA
az workload-orchestration-preview config-template version show

Get a Config Template Version Resource.

Extension GA
az workload-orchestration-preview config-template wait

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

Extension GA
az workload-orchestration-preview configuration

Workload-orchestration-preview configuration helps to manage configurations.

Extension GA
az workload-orchestration-preview configuration download

Download configurations available at specified hierarchical entity.

Extension GA
az workload-orchestration-preview configuration schema Extension GA
az workload-orchestration-preview configuration schema show

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

Extension GA
az workload-orchestration-preview configuration set

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

Extension GA
az workload-orchestration-preview configuration show

To get a configurations available at specified hierarchical entity.

Extension GA
az workload-orchestration-preview context

Workload-orchestration-preview context helps to manage contexts.

Extension GA
az workload-orchestration-preview context add-capability

Add capabilities to a context (idempotent).

Extension GA
az workload-orchestration-preview context create

Create Context Resource.

Extension GA
az workload-orchestration-preview context current

Show current context information.

Extension GA
az workload-orchestration-preview context delete

Delete Context Resource.

Extension GA
az workload-orchestration-preview context list

List by specified resource group.

Extension GA
az workload-orchestration-preview context list-subscriptions

List by subscription.

Extension GA
az workload-orchestration-preview context remove-capability

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

Extension GA
az workload-orchestration-preview context set

Set current context using context ID.

Extension GA
az workload-orchestration-preview context show

Get Context Resource.

Extension GA
az workload-orchestration-preview context site-reference

Manage workload orchestration site reference context.

Extension GA
az workload-orchestration-preview context site-reference create

Create Site Reference Resource.

Extension GA
az workload-orchestration-preview context site-reference delete

Delete Site Reference Resource.

Extension GA
az workload-orchestration-preview context site-reference list

List Site Reference Resources.

Extension GA
az workload-orchestration-preview context site-reference show

Get Site Reference Resource.

Extension GA
az workload-orchestration-preview context site-reference wait

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

Extension GA
az workload-orchestration-preview context use

Use Context by name.

Extension GA
az workload-orchestration-preview context wait

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

Extension GA
az workload-orchestration-preview diagnostic

Workload-orchestration-preview diagnostic helps to manage Diagnostics.

Extension GA
az workload-orchestration-preview diagnostic create

Create new or updates existing Diagnostic resource.

Extension GA
az workload-orchestration-preview diagnostic delete

Delete specified Diagnostic resource.

Extension GA
az workload-orchestration-preview diagnostic list

List Diagnostics resources within an Azure subscription.

Extension GA
az workload-orchestration-preview diagnostic show

Get details of specified Diagnostic resource.

Extension GA
az workload-orchestration-preview diagnostic update

Update new or updates existing Diagnostic resource.

Extension GA
az workload-orchestration-preview diagnostic wait

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

Extension GA
az workload-orchestration-preview hierarchy

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

Extension GA
az workload-orchestration-preview hierarchy create

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

Extension GA
az workload-orchestration-preview schema

Workload-orchestration-preview schema helps to manage Schemas.

Extension GA
az workload-orchestration-preview schema create

Create a Schema Resource.

Extension GA
az workload-orchestration-preview schema delete

Delete a Schema Resource.

Extension GA
az workload-orchestration-preview schema list

List by subscription.

Extension GA
az workload-orchestration-preview schema remove-version

Remove Schema Version Resource.

Extension GA
az workload-orchestration-preview schema show

Get a Schema Resource.

Extension GA
az workload-orchestration-preview schema version

Workload-orchestration-preview schema version helps to manage Schemas.

Extension GA
az workload-orchestration-preview schema version list

List by specified resource group.

Extension GA
az workload-orchestration-preview schema version show

Get a Schema Version Resource.

Extension GA
az workload-orchestration-preview schema version wait

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

Extension GA
az workload-orchestration-preview schema wait

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

Extension GA
az workload-orchestration-preview solution-deployment

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

Extension GA
az workload-orchestration-preview solution-deployment create

Create or update a SolutionDeployment Resource.

Extension GA
az workload-orchestration-preview solution-deployment delete

Delete a SolutionDeployment Resource.

Extension GA
az workload-orchestration-preview solution-deployment list

List SolutionDeployment Resources.

Extension GA
az workload-orchestration-preview solution-deployment show

Get a SolutionDeployment Resource.

Extension GA
az workload-orchestration-preview solution-deployment wait

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

Extension GA
az workload-orchestration-preview solution-template

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

Extension GA
az workload-orchestration-preview solution-template bulk-deploy

Post request for bulk deploy.

Extension GA
az workload-orchestration-preview solution-template bulk-publish

Post request for bulk publish.

Extension GA
az workload-orchestration-preview solution-template bulk-review

Post request for bulk review.

Extension GA
az workload-orchestration-preview solution-template create

Create a Solution Template Resource.

Extension GA
az workload-orchestration-preview solution-template delete

Delete a Solution Template Resource.

Extension GA
az workload-orchestration-preview solution-template list

List by specified resource group.

Extension GA
az workload-orchestration-preview solution-template list-subscriptions

List by subscription.

Extension GA
az workload-orchestration-preview solution-template remove-version

Remove Solution Template Version Resource.

Extension GA
az workload-orchestration-preview solution-template show

Get a Solution Template Resource.

Extension GA
az workload-orchestration-preview solution-template update-capabilities

Update the capabilities of a Solution Template Resource.

Extension GA
az workload-orchestration-preview solution-template version

Manage solution template versions in workload orchestration.

Extension GA
az workload-orchestration-preview solution-template version list

List Solution Template Version Resources.

Extension GA
az workload-orchestration-preview solution-template version show

Get a Solution Template Version Resource.

Extension GA
az workload-orchestration-preview solution-template wait

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

Extension GA
az workload-orchestration-preview support

Commands for troubleshooting and diagnostics of workload orchestration deployments.

Extension Preview
az workload-orchestration-preview support create-bundle

Create a support bundle for troubleshooting workload orchestration issues.

Extension Preview
az workload-orchestration-preview sync

Sync workload orchestration resources for a custom location.

Extension GA

az workload-orchestration-preview sync

Sync workload orchestration resources for a custom location.

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

Examples

Sync resources for a custom location

az workload-orchestration-preview 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