az k8s-runtime bgp-peer

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 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
                               [--bfd-profile]
                               [--bgp-multi-hop {Disabled, Enabled}]
                               [--hold-time]
                               [--keep-alive-time]
                               [--my-asn]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--node-selector]
                               [--peer-address]
                               [--peer-asn]
                               [--peer-port]

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

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

--bfd-profile

BFD Profile.

Property	Value
Parameter group:	Properties Arguments

--bgp-multi-hop

EBGP multiple hop.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--hold-time

Hold time, per RFC4271.

Property	Value
Parameter group:	Properties Arguments

--keep-alive-time

Keepalive time, per RFC4271.

Property	Value
Parameter group:	Properties Arguments

--my-asn

My ASN.

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

--node-selector

A dynamic label mapping to select related nodes to peer with. For instance, if you want to create a BGP peer only for nodes 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

--peer-address

Peer Address.

Property	Value
Parameter group:	Properties Arguments

--peer-asn

Peer ASN.

Property	Value
Parameter group:	Properties Arguments

--peer-port

Peer BGP port.

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

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

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

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

Update a BgpPeer.

az k8s-runtime bgp-peer update --bgp-peer-name
                               --resource-uri
                               [--add]
                               [--bfd-profile]
                               [--bgp-multi-hop {Disabled, Enabled}]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--hold-time]
                               [--keep-alive-time]
                               [--my-asn]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--node-selector]
                               [--peer-address]
                               [--peer-asn]
                               [--peer-port]
                               [--remove]
                               [--set]

Examples

Update a BGP peer

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

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

--bfd-profile

BFD Profile.

Property	Value
Parameter group:	Properties Arguments

--bgp-multi-hop

EBGP multiple hop.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

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

--hold-time

Hold time, per RFC4271.

Property	Value
Parameter group:	Properties Arguments

--keep-alive-time

Keepalive time, per RFC4271.

Property	Value
Parameter group:	Properties Arguments

--my-asn

My ASN.

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

--node-selector

Property	Value
Parameter group:	Properties Arguments

--peer-address

Peer Address.

Property	Value
Parameter group:	Properties Arguments

--peer-asn

Peer ASN.

Property	Value
Parameter group:	Properties Arguments

--peer-port

Peer BGP port.

Property	Value
Parameter group:	Properties Arguments

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

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

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

Κοινή χρήση μέσω

az k8s-runtime bgp-peer

Commands

az k8s-runtime bgp-peer create

Examples

Required Parameters

Optional Parameters

az k8s-runtime bgp-peer delete

Examples

Required Parameters

Optional Parameters

az k8s-runtime bgp-peer list

Examples

Required Parameters

Optional Parameters

az k8s-runtime bgp-peer show

Examples

Required Parameters

az k8s-runtime bgp-peer update

Examples

Required Parameters

Optional Parameters

az k8s-runtime bgp-peer wait

Required Parameters

Optional Parameters

Σχόλια