az workload-manager workload-space runtime-binding

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

Manage Runtime Binding.

Commands

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

Create a runtime binding.

az workload-manager workload-space runtime-binding create --binding-name --name
                                                          --resource-group
                                                          --space-name
                                                          [--acquire-policy-token]
                                                          [--change-reference]
                                                          [--identity-profile]
                                                          [--kind {Kubernetes, ServerlessContainers}]
                                                          [--location]
                                                          [--managed]
                                                          [--network-profile]
                                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                          [--referenced]
                                                          [--tags]

Examples

Attach a referenced Kubernetes runtime binding

az workload-manager workload-space runtime-binding create --resource-group rg-workload --space-name managed-agents-prod --binding-name customer-aks --location eastus2 --kind Kubernetes --referenced "{resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/aks-rg/providers/Microsoft.ContainerService/managedClusters/aks-prod}"

Create a managed Kubernetes runtime binding

az workload-manager workload-space runtime-binding create --resource-group rg-workload --space-name managed-agents-prod --binding-name kubernetes-default --location eastus2 --kind Kubernetes --managed "{managed-profile:{offering:Automatic}}"

Create a managed serverless container runtime binding

az workload-manager workload-space runtime-binding create --resource-group rg-workload --space-name managed-agents-prod --binding-name serverless-default --location eastus2 --kind ServerlessContainers --managed "{managed-profile:{provider:ACI}}" --identity-profile "{execution-identity:{service-managed:{},scope:SandboxGroup}}"

Required Parameters

--binding-name --name -n

The name of the RuntimeBinding.

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--identity-profile

The runtime identity configuration for a managed runtime. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

Property	Value
Parameter group:	Resource Arguments
Accepted values:	Kubernetes, ServerlessContainers

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

--managed

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

Property	Value
Parameter group:	Properties Arguments

--network-profile

The runtime network configuration for a managed runtime. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--referenced

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

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-binding delete

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

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

Examples

Delete a runtime binding

az workload-manager workload-space runtime-binding delete --resource-group rg-workload --space-name managed-agents-prod --binding-name kubernetes-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

--binding-name --name -n

The name of the RuntimeBinding.

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

--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-binding list

List runtime bindings in a workload space.

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

Examples

List runtime bindings in a workload space

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

Get a runtime binding.

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

Examples

Get a runtime binding

az workload-manager workload-space runtime-binding show --resource-group rg-workload --space-name managed-agents-prod --binding-name kubernetes-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.

--binding-name --name -n

The name of the RuntimeBinding.

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

--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-binding update

Update mutable runtime binding properties.

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

Examples

Update mutable runtime binding network configuration

az workload-manager workload-space runtime-binding update --resource-group rg-workload --space-name managed-agents-prod --binding-name serverless-default --network-profile "{subnet-resource-id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-network/providers/Microsoft.Network/virtualNetworks/workload-vnet/subnets/execution,egress-mode:CustomerManaged}"

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

--binding-name --name -n

The name of the RuntimeBinding.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--identity-profile

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

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

--network-profile

The runtime network configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

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

--binding-name --name -n

The name of the RuntimeBinding.

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

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