az workload-orchestration cluster

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.

Prepare an Arc-connected Kubernetes cluster for Workload Orchestration.

Commands

Name	Description	Type	Status
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 cluster init (workload-orchestration extension)

Prepare an Arc-connected Kubernetes cluster for Workload Orchestration.

Installs all prerequisites on an Arc-connected cluster to make it ready for Workload Orchestration. Idempotent - skips components already installed. Steps performed:

1. Verify cluster is Arc-connected with required features enabled
2. Install Workload Orchestration Extension Dependencies
3. Install Workload Orchestration Extension
4. Create Custom Location (validates cluster binding if already exists).

az workload-orchestration cluster init --cluster-name
                                       --location
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--custom-location-location]
                                       [--custom-location-name]
                                       [--custom-location-resource-group]
                                       [--extension-dependency-version]
                                       [--extension-name]
                                       [--extension-version]
                                       [--release-train]

Examples

Initialize a cluster with defaults

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap

Use a specific release train

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --release-train dev

Pin a specific WO extension version

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --extension-version 2.1.28

Pin a dependency extension (partial-value shorthand)

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --extension-dependency-version iotplatform=0.7.6

Pin a dependency extension (full-value shorthand)

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --extension-dependency-version "{iotplatform:0.7.6}"

Pin dependencies from a JSON file

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --extension-dependency-version deps.json

Custom location name

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --custom-location-name my-cl

Custom location in a different resource group

az workload-orchestration cluster init -c my-cluster -g cluster-rg -l eastus2euap --custom-location-resource-group cl-rg

Custom location in a different region

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --custom-location-location westus2

Required Parameters

--cluster-name -c

Name of the Arc-connected Kubernetes cluster.

--location -l

Azure region for the custom location (e.g. eastus2euap).

--resource-group -g

Resource group of the Arc-connected cluster.

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

--custom-location-location

Azure region where the custom location will be created. Default: same as --location.

--custom-location-name

Name for the custom location. Default: {cluster-name}-cl.

--custom-location-resource-group

Resource group where the custom location will be created. Default: same as --resource-group.

--extension-dependency-version

Pin dependency extension versions. Supported key: iotplatform. Example: iotplatform=0.7.6, {iotplatform:0.7.6}, deps.json. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--extension-name

Name for the WO extension resource. Default: wo-extension.

--extension-version

Specific WO extension version to install.

--release-train

Extension release train. Default: stable.

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

Prepare an Arc-connected Kubernetes cluster for Workload Orchestration.

Installs all prerequisites on an Arc-connected cluster to make it ready for Workload Orchestration. Idempotent - skips components already installed. Steps performed:

1. Verify cluster is Arc-connected with required features enabled
2. Install Workload Orchestration Extension Dependencies
3. Install Workload Orchestration Extension
4. Create Custom Location (validates cluster binding if already exists).

az workload-orchestration cluster init --cluster-name
                                       --location
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--custom-location-location]
                                       [--custom-location-name]
                                       [--custom-location-resource-group]
                                       [--extension-dependency-version]
                                       [--extension-name]
                                       [--extension-version]
                                       [--release-train]

Examples

Initialize a cluster with defaults

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap

Use a specific release train

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --release-train dev

Pin a specific WO extension version

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --extension-version 2.1.28

Pin a dependency extension (partial-value shorthand)

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --extension-dependency-version iotplatform=0.7.6

Pin a dependency extension (full-value shorthand)

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --extension-dependency-version "{iotplatform:0.7.6}"

Pin dependencies from a JSON file

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --extension-dependency-version deps.json

Custom location name

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --custom-location-name my-cl

Custom location in a different resource group

az workload-orchestration cluster init -c my-cluster -g cluster-rg -l eastus2euap --custom-location-resource-group cl-rg

Custom location in a different region

az workload-orchestration cluster init -c my-cluster -g my-rg -l eastus2euap --custom-location-location westus2

Required Parameters

--cluster-name -c

Name of the Arc-connected Kubernetes cluster.

--location -l

Azure region for the custom location (e.g. eastus2euap).

--resource-group -g

Resource group of the Arc-connected cluster.

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

--custom-location-location

Azure region where the custom location will be created. Default: same as --location.

--custom-location-name

Name for the custom location. Default: {cluster-name}-cl.

--custom-location-resource-group

Resource group where the custom location will be created. Default: same as --resource-group.

--extension-dependency-version

Pin dependency extension versions. Supported key: iotplatform. Example: iotplatform=0.7.6, {iotplatform:0.7.6}, deps.json. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--extension-name

Name for the WO extension resource. Default: wo-extension.

--extension-version

Specific WO extension version to install.

--release-train

Extension release train. Default: stable.

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