az workload-manager workload-space runtime-link

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

Manage Runtime Link.

Commands

Name	Description	Type	Status
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 runtime-link create

Create a runtime link.

az workload-manager workload-space runtime-link create --link-name --name
                                                       --resource-group
                                                       --space-name
                                                       [--acquire-policy-token]
                                                       [--capacity-profile]
                                                       [--change-reference]
                                                       [--execution-binding --execution-binding-resource-id]
                                                       [--integration-profile]
                                                       [--location]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--orchestrator-binding --orchestrator-binding-resource-id]
                                                       [--tags]

Examples

Create a Kubernetes-only runtime link

az workload-manager workload-space runtime-link create --resource-group rg-workload --space-name managed-agents-prod --link-name kubernetes-only --location eastus2 --orchestrator-binding /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-workload/providers/Microsoft.Compute/workloadSpaces/managed-agents-prod/runtimeBindings/customer-aks

Create a runtime link between Kubernetes and serverless containers

az workload-manager workload-space runtime-link create --resource-group rg-workload --space-name managed-agents-prod --link-name default --location eastus2 --orchestrator-binding /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-workload/providers/Microsoft.Compute/workloadSpaces/managed-agents-prod/runtimeBindings/kubernetes-default --execution-binding /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-workload/providers/Microsoft.Compute/workloadSpaces/managed-agents-prod/runtimeBindings/serverless-default --capacity-profile "{minimum-nodes:1,maximum-nodes:100}"

Required Parameters

--link-name --name -n

The name of the RuntimeLink.

--resource-group -g

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

--space-name

The name of the WorkloadSpace.

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

--capacity-profile

The mutable capacity policy for the runtime composition. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--execution-binding --execution-binding-resource-id

The optional sibling runtime binding that provides execution.

Property	Value
Parameter group:	Properties Arguments

--integration-profile

The provider integration identity configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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

--orchestrator-binding --orchestrator-binding-resource-id

The sibling runtime binding that provides orchestration.

Property	Value
Parameter group:	Properties Arguments

--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 runtime-link delete

Delete a runtime link without deleting its runtime bindings.

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

Examples

Delete a runtime link

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

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

--link-name --name -n

The name of the RuntimeLink.

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

--space-name

The name of the WorkloadSpace.

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 runtime-link list

List runtime links in a workload space.

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

Examples

List runtime links in a workload space

az workload-manager workload-space runtime-link list --resource-group rg-workload --space-name managed-agents-prod

Required Parameters

--resource-group -g

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

--space-name

The name of the WorkloadSpace.

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

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 runtime-link show

Get a runtime link.

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

Examples

Get a runtime link

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

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

--link-name --name -n

The name of the RuntimeLink.

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

--space-name

The name of the WorkloadSpace.

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 runtime-link update

Update mutable runtime link properties.

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

Examples

Update runtime link capacity

az workload-manager workload-space runtime-link update --resource-group rg-workload --space-name managed-agents-prod --link-name default --capacity-profile "{minimum-nodes:2,maximum-nodes:150}"

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

--capacity-profile

The mutable capacity policy for the runtime composition. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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

--link-name --name -n

The name of the RuntimeLink.

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

--space-name

The name of the WorkloadSpace.

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 runtime-link wait

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

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

--link-name --name -n

The name of the RuntimeLink.

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

--space-name

The name of the WorkloadSpace.

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