Share via

az k8s-runtime load-balancer

  • Reference

Note

This reference is part of the k8s-runtime extension for the Azure CLI (version 2.57.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]
                                    [--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

--addresses

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

--advertise-mode

Advertise Mode.

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.

--no-wait

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

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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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

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

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az k8s-runtime load-balancer update

Update a LoadBalancer.

az k8s-runtime load-balancer update --load-balancer-name
                                    --resource-uri
                                    [--add]
                                    [--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]
                                    [--set]

Required Parameters

--load-balancer-name

The name of the LoadBalancer.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

Optional Parameters

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

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

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

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.

--set

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.