az workload-orchestration
Note
This reference is part of the workload-orchestration extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az workload-orchestration 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 |
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 |
Create a Config Template Resource. |
Extension | GA |
| az workload-orchestration config-template delete |
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 |
Show linked hierarchies for a config template. |
Extension | GA |
| az workload-orchestration config-template link |
Link a Config Template to hierarchies. |
Extension | GA |
| az workload-orchestration config-template list |
List by subscription. |
Extension | GA |
| az workload-orchestration config-template remove-version |
Remove Config Template Version Resource. |
Extension | GA |
| az workload-orchestration config-template show |
Get a Config Template Resource. |
Extension | GA |
| az workload-orchestration config-template unlink |
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 |
List Config Template Version Resources. |
Extension | GA |
| az workload-orchestration config-template version show |
Get a Config Template Version Resource. |
Extension | GA |
| az workload-orchestration config-template wait |
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 |
Download configurations available at specified hierarchical entity. |
Extension | GA |
| az workload-orchestration configuration schema | Extension | GA | |
| az workload-orchestration configuration schema show |
Show the schema placeholder for a configuration template or solution template. |
Extension | GA |
| az workload-orchestration configuration set |
To set the values to configurations available at specified hierarchical entity. |
Extension | GA |
| az workload-orchestration configuration show |
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 |
Add capabilities to a context (idempotent). |
Extension | GA |
| az workload-orchestration context create |
Create Context Resource. |
Extension | GA |
| az workload-orchestration context current |
Show current context information. |
Extension | GA |
| az workload-orchestration context delete |
Delete Context Resource. |
Extension | GA |
| az workload-orchestration context list |
List by specified resource group. |
Extension | GA |
| az workload-orchestration context list-subscriptions |
List by subscription. |
Extension | GA |
| az workload-orchestration context remove-capability |
Remove one or more capabilities from a context (idempotent). |
Extension | GA |
| az workload-orchestration context set |
Set current context using context ID. |
Extension | GA |
| az workload-orchestration context show |
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 |
Create Site Reference Resource. |
Extension | GA |
| az workload-orchestration context site-reference delete |
Delete Site Reference Resource. |
Extension | GA |
| az workload-orchestration context site-reference list |
List Site Reference Resources. |
Extension | GA |
| az workload-orchestration context site-reference show |
Get Site Reference Resource. |
Extension | GA |
| az workload-orchestration context site-reference wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az workload-orchestration context use |
Use Context by name. |
Extension | GA |
| az workload-orchestration context wait |
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 |
Create new or updates existing Diagnostic resource. |
Extension | GA |
| az workload-orchestration diagnostic delete |
Delete specified Diagnostic resource. |
Extension | GA |
| az workload-orchestration diagnostic list |
List Diagnostics resources within an Azure subscription. |
Extension | GA |
| az workload-orchestration diagnostic show |
Get details of specified Diagnostic resource. |
Extension | GA |
| az workload-orchestration diagnostic update |
Update new or updates existing Diagnostic resource. |
Extension | GA |
| az workload-orchestration diagnostic wait |
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 |
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 |
Create a Schema Resource. |
Extension | GA |
| az workload-orchestration schema delete |
Delete a Schema Resource. |
Extension | GA |
| az workload-orchestration schema list |
List by subscription. |
Extension | GA |
| az workload-orchestration schema remove-version |
Remove Schema Version Resource. |
Extension | GA |
| az workload-orchestration schema show |
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 |
List by specified resource group. |
Extension | GA |
| az workload-orchestration schema version show |
Get a Schema Version Resource. |
Extension | GA |
| az workload-orchestration schema version wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az workload-orchestration schema 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 |
Post request for bulk deploy. |
Extension | GA |
| az workload-orchestration solution-template bulk-publish |
Post request for bulk publish. |
Extension | GA |
| az workload-orchestration solution-template bulk-review |
Post request for bulk review. |
Extension | GA |
| az workload-orchestration solution-template create |
Create a Solution Template Resource. |
Extension | GA |
| az workload-orchestration solution-template delete |
Delete a Solution Template Resource. |
Extension | GA |
| az workload-orchestration solution-template list |
List by specified resource group. |
Extension | GA |
| az workload-orchestration solution-template list-subscriptions |
List by subscription. |
Extension | GA |
| az workload-orchestration solution-template remove-version |
Remove Solution Template Version Resource. |
Extension | GA |
| az workload-orchestration solution-template show |
Get a Solution Template Resource. |
Extension | GA |
| az workload-orchestration solution-template update-capabilities |
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 |
List Solution Template Version Resources. |
Extension | GA |
| az workload-orchestration solution-template version show |
Get a Solution Template Version Resource. |
Extension | GA |
| az workload-orchestration solution-template wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az workload-orchestration support |
Commands for troubleshooting and diagnostics of workload orchestration deployments. |
Extension | Preview |
| az workload-orchestration support create-bundle |
Create a support bundle for troubleshooting workload orchestration issues. |
Extension | Preview |
| az workload-orchestration sync |
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
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/myCustomLocationRequired Parameters
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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
