az workload-manager workload-space

Note

This reference is part of the workload-manager extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az workload-manager workload-space command. Learn more about extensions.

Manage Workload Space.

Commands

Name Description Type Status
az workload-manager workload-space capability

Manage Capability.

Extension GA
az workload-manager workload-space capability create

Create a capability.

Extension GA
az workload-manager workload-space capability delete

Disable and delete a capability.

Extension GA
az workload-manager workload-space capability list

List capabilities in a workload space.

Extension GA
az workload-manager workload-space capability show

Get a capability.

Extension GA
az workload-manager workload-space capability update

Update mutable capability properties.

Extension GA
az workload-manager workload-space capability wait

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

Extension GA
az workload-manager workload-space create

Create a workload space.

Extension GA
az workload-manager workload-space delete

Delete a workload space and its owned resources.

Extension GA
az workload-manager workload-space list

List workload spaces in a subscription.

Extension GA
az workload-manager workload-space runtime-binding

Manage Runtime Binding.

Extension GA
az workload-manager workload-space runtime-binding create

Create a runtime binding.

Extension GA
az workload-manager workload-space runtime-binding delete

Delete a runtime binding without deleting customer-owned referenced resources.

Extension GA
az workload-manager workload-space runtime-binding list

List runtime bindings in a workload space.

Extension GA
az workload-manager workload-space runtime-binding show

Get a runtime binding.

Extension GA
az workload-manager workload-space runtime-binding update

Update mutable runtime binding properties.

Extension GA
az workload-manager workload-space runtime-binding wait

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

Extension GA
az workload-manager workload-space runtime-link

Manage Runtime Link.

Extension GA
az workload-manager workload-space runtime-link create

Create a runtime link.

Extension GA
az workload-manager workload-space runtime-link delete

Delete a runtime link without deleting its runtime bindings.

Extension GA
az workload-manager workload-space runtime-link list

List runtime links in a workload space.

Extension GA
az workload-manager workload-space runtime-link show

Get a runtime link.

Extension GA
az workload-manager workload-space runtime-link update

Update mutable runtime link properties.

Extension GA
az workload-manager workload-space runtime-link wait

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

Extension GA
az workload-manager workload-space show

Get a workload space.

Extension GA
az workload-manager workload-space up

Provision a workload space with runtime bindings, a runtime link, and capabilities.

Extension GA
az workload-manager workload-space update

Update mutable workload space properties.

Extension GA
az workload-manager workload-space wait

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

Extension GA

az workload-manager workload-space create

Create a workload space.

az workload-manager workload-space create --name --space-name
                                          --resource-group
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--location]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--tags]

Examples

Create a production workload space

az workload-manager workload-space create --resource-group rg-workload --space-name managed-agents-prod --location eastus2 --tags "{environment:Production}"

Required Parameters

--name --space-name -n

The name of the WorkloadSpace.

--resource-group -g

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

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
--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
--tags

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

Property Value
Parameter group: Resource 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-manager workload-space delete

Delete a workload space and its owned resources.

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

Examples

Delete a workload space

az workload-manager workload-space delete --resource-group rg-workload --space-name managed-agents-prod

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

The name of the WorkloadSpace.

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-manager workload-space list

List workload spaces in a subscription.

az workload-manager workload-space list [--max-items]
                                        [--next-token]
                                        [--resource-group]

Examples

List workload spaces in a subscription

az workload-manager workload-space list

List workload spaces in a resource group

az workload-manager workload-space list --resource-group rg-workload

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-manager workload-space show

Get a workload space.

az workload-manager workload-space show [--ids]
                                        [--name --space-name]
                                        [--resource-group]
                                        [--subscription]

Examples

Get a workload space

az workload-manager workload-space show --resource-group rg-workload --space-name managed-agents-prod

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

The name of the WorkloadSpace.

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-manager workload-space up

Provision a workload space with runtime bindings, a runtime link, and capabilities.

Deploy a workload space, managed AKS and ACI runtime bindings, a runtime link, and AgentSandbox and PodSnapshotRestore capabilities. Use an existing resource group with the required provider registrations and service permissions configured.

Location defaults to your configured location, or the resource group's location if no default is configured. Use --location to select another supported location.

Supply --managed-cluster-resource-id, --workload-execution-subnet-id and --runtime-link-subnet-id together to use an existing AKS cluster. The cluster must be in the selected subscription and location. Both subnets must be in that subscription and the cluster's VNet; the runtime-link subnet must be empty and separate from the AKS and ACI subnets. The service validates cluster topology.

Child names are aks, aci, link, agent-sandbox and pod-snapshot-restore. Reruns update the same resources and reapply the supplied configuration. Existing bindings must retain their managed or referenced mode. Unrelated resources are preserved. If deployment fails, resources already created remain available; review deployment errors before retrying.

Return the ARM deployment result, with the workload-space ID in its outputs. --no-wait returns after submission; ARM continues the entire deployment. Use az deployment group show to inspect deployment progress or failures.

az workload-manager workload-space up --name --space-name
                                      --resource-group
                                      [--acquire-policy-token]
                                      [--change-reference]
                                      [--deployment-name]
                                      [--execution-subnet-id --workload-execution-subnet-id]
                                      [--location]
                                      [--managed-cluster-id --managed-cluster-resource-id]
                                      [--no-wait]
                                      [--runtime-link-subnet-id]
                                      [--tags]

Examples

Provision a managed runtime composition using the default location.

az workload-manager workload-space up --resource-group MyResourceGroup --name MySpace

Use an existing AKS cluster with separate ACI and runtime-link subnets.

az workload-manager workload-space up --resource-group MyResourceGroup --name MySpace --location eastus2 --managed-cluster-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ClusterRG/providers/Microsoft.ContainerService/managedClusters/MyCluster --workload-execution-subnet-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/NetworkRG/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/aci --runtime-link-subnet-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/NetworkRG/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/link

Submit a named deployment without waiting for completion.

az workload-manager workload-space up -g MyResourceGroup -n MySpace -l eastus2 --deployment-name MyDeployment --tags environment=dev --no-wait

Required Parameters

--name --space-name -n

Name of the workload space.

--resource-group -g

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

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

ARM deployment name. Defaults to the workload-space name.

--execution-subnet-id --workload-execution-subnet-id

ACI execution subnet resource ID. Requires --managed-cluster-resource-id and --runtime-link-subnet-id.

--location -l

Deployment location. Defaults to the configured location or the resource group location.

--managed-cluster-id --managed-cluster-resource-id

Resource ID of an existing AKS cluster in the selected subscription and location. Requires both subnet IDs.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--runtime-link-subnet-id

Empty subnet resource ID for the runtime link. Must be distinct from the execution subnet, in the same VNet. Requires --managed-cluster-resource-id and --workload-execution-subnet-id.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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-manager workload-space update

Update mutable workload space properties.

az workload-manager workload-space update [--acquire-policy-token]
                                          [--change-reference]
                                          [--ids]
                                          [--name --space-name]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--resource-group]
                                          [--subscription]
                                          [--tags]

Examples

Update workload space tags

az workload-manager workload-space update --resource-group rg-workload --space-name managed-agents-prod --tags "{environment:Production}"

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

The name of the WorkloadSpace.

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
--tags

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

Property Value
Parameter group: Properties 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-manager workload-space wait

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

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

The name of the WorkloadSpace.

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