az k8s-runtime load-balancer

Note

This reference is part of the k8s-runtime extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az k8s-runtime load-balancer command. Learn more about extensions.

Manage load balancers of Arc Kubernetes clusters.

Commands

Name	Description	Type	Status
az k8s-runtime load-balancer create	Create a LoadBalancer.	Extension	GA
az k8s-runtime load-balancer delete	Delete a LoadBalancer.	Extension	GA
az k8s-runtime load-balancer disable	Disable load_balancer service in a connected cluster.	Extension	GA
az k8s-runtime load-balancer enable	Enable load balancer service in a connected cluster.	Extension	GA
az k8s-runtime load-balancer list	List LoadBalancer resources by parent.	Extension	GA
az k8s-runtime load-balancer show	Get a LoadBalancer.	Extension	GA
az k8s-runtime load-balancer update	Update a LoadBalancer.	Extension	GA
az k8s-runtime load-balancer wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az k8s-runtime load-balancer create

Create a LoadBalancer.

az k8s-runtime load-balancer create --load-balancer-name
                                    --resource-uri
                                    [--addresses]
                                    [--advertise-mode {ARP, BGP, Both}]
                                    [--bgp-peers]
                                    [--communities]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--service-selector]

Examples

Create a load balancer

az k8s-runtime load-balancer create --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --addresses "192.168.50.1/32" --advertise-mode ARP --service-selector ""

Required Parameters

--load-balancer-name

The name of the LoadBalancer.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--addresses

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

Property	Value
Parameter group:	Properties Arguments

--advertise-mode

Advertise Mode.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	ARP, BGP, Both

--bgp-peers

The list of BGP peers it should advertise to. Null or empty means to advertise to all peers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--communities

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

--service-selector

A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field. 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.

--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 k8s-runtime load-balancer delete

Delete a LoadBalancer.

az k8s-runtime load-balancer delete --load-balancer-name
                                    --resource-uri
                                    [--yes]

Examples

Delete a load balancer

az k8s-runtime load-balancer delete --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

Required Parameters

--load-balancer-name

The name of the LoadBalancer.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

--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 k8s-runtime load-balancer disable

Disable load_balancer service in a connected cluster.

az k8s-runtime load-balancer disable --resource-uri

Required Parameters

--resource-uri

The resource uri of the connected cluster.

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 k8s-runtime load-balancer enable

Enable load balancer service in a connected cluster.

az k8s-runtime load-balancer enable --resource-uri

Required Parameters

--resource-uri

The resource uri of the connected cluster.

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 k8s-runtime load-balancer list

List LoadBalancer resources by parent.

az k8s-runtime load-balancer list --resource-uri
                                  [--max-items]
                                  [--next-token]

Examples

List all load balancers in a cluster

az k8s-runtime load-balancer list --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

Required Parameters

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

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 k8s-runtime load-balancer show

Get a LoadBalancer.

az k8s-runtime load-balancer show --load-balancer-name
                                  --resource-uri

Examples

Get a load balancer

az k8s-runtime load-balancer show --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

Required Parameters

--load-balancer-name

The name of the LoadBalancer.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

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 k8s-runtime load-balancer update

Update a LoadBalancer.

az k8s-runtime load-balancer update --load-balancer-name
                                    --resource-uri
                                    [--add]
                                    [--addresses]
                                    [--advertise-mode {ARP, BGP, Both}]
                                    [--bgp-peers]
                                    [--communities]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--remove]
                                    [--service-selector]
                                    [--set]

Examples

Update a load balancer

az k8s-runtime load-balancer update --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --advertise-mode ARP

Required Parameters

--load-balancer-name

The name of the LoadBalancer.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--addresses

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

Property	Value
Parameter group:	Properties Arguments

--advertise-mode

Advertise Mode.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	ARP, BGP, Both

--bgp-peers

The list of BGP peers it should advertise to. Null or empty means to advertise to all peers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--communities

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

Property	Value
Parameter group:	Properties Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--service-selector

Property	Value
Parameter group:	Properties Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update 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 k8s-runtime load-balancer wait

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

az k8s-runtime load-balancer wait --load-balancer-name
                                  --resource-uri
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--interval]
                                  [--timeout]
                                  [--updated]

Required Parameters

--load-balancer-name

The name of the LoadBalancer.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

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

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

Share via

az k8s-runtime load-balancer

Commands

az k8s-runtime load-balancer create

Examples

Required Parameters

Optional Parameters

az k8s-runtime load-balancer delete

Examples

Required Parameters

Optional Parameters

az k8s-runtime load-balancer disable

Required Parameters

az k8s-runtime load-balancer enable

Required Parameters

az k8s-runtime load-balancer list

Examples

Required Parameters

Optional Parameters

az k8s-runtime load-balancer show

Examples

Required Parameters

az k8s-runtime load-balancer update

Examples

Required Parameters

Optional Parameters

az k8s-runtime load-balancer wait

Required Parameters

Optional Parameters

Feedback