Share via

az k8s-runtime bgp-peer

  • 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 bgp-peer command. Learn more about extensions.

Manage BGP peers of Arc Kubernetes clusters.

Commands

Name Description Type Status
az k8s-runtime bgp-peer create

Create a BgpPeer.

 Extension GA
az k8s-runtime bgp-peer delete

Delete a BgpPeer.

 Extension GA
az k8s-runtime bgp-peer list

List BgpPeer resources by parent.

 Extension GA
az k8s-runtime bgp-peer show

Get a BgpPeer.

 Extension GA
az k8s-runtime bgp-peer update

Update a BgpPeer.

 Extension GA
az k8s-runtime bgp-peer wait

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

 Extension GA

az k8s-runtime bgp-peer create

Create a BgpPeer.

az k8s-runtime bgp-peer create --bgp-peer-name
                               --resource-uri
                               [--my-asn]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--peer-address]
                               [--peer-asn]

Examples

Create a BGP Peer

az k8s-runtime bgp-peer create --bgp-peer-name bgpPeer1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --my-asn 10000 --peer-asn 20000 --peer-address 192.168.50.1

Required Parameters

--bgp-peer-name

The name of the BgpPeer.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

Optional Parameters

--my-asn

My ASN.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--peer-address

Peer Address.

--peer-asn

Peer ASN.

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 bgp-peer delete

Delete a BgpPeer.

az k8s-runtime bgp-peer delete --bgp-peer-name
                               --resource-uri
                               [--yes]

Examples

Delete a BGP peer

az k8s-runtime bgp-peer delete --bgp-peer-name bgpPeer1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

Required Parameters

--bgp-peer-name

The name of the BgpPeer.

--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 bgp-peer list

List BgpPeer resources by parent.

az k8s-runtime bgp-peer list --resource-uri
                             [--max-items]
                             [--next-token]

Examples

List all BGP peers in a cluster

az k8s-runtime bgp-peer 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 bgp-peer show

Get a BgpPeer.

az k8s-runtime bgp-peer show --bgp-peer-name
                             --resource-uri

Examples

Get a BGP peer

az k8s-runtime bgp-peer show --bgp-peer-name bgpPeer1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

Required Parameters

--bgp-peer-name

The name of the BgpPeer.

--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 bgp-peer update

Update a BgpPeer.

az k8s-runtime bgp-peer update --bgp-peer-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

--bgp-peer-name

The name of the BgpPeer.

--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 OR --remove propertyToRemove.

--set

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

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 bgp-peer wait

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

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

Required Parameters

--bgp-peer-name

The name of the BgpPeer.

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