az k8s-runtime bgp-peer
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
The name of the BgpPeer.
The fully qualified Azure Resource manager identifier of the resource.
Optional Parameters
My ASN.
Do not wait for the long-running operation to finish.
Peer Address.
Peer ASN.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the BgpPeer.
The fully qualified Azure Resource manager identifier of the resource.
Optional Parameters
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The fully qualified Azure Resource manager identifier of the resource.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the BgpPeer.
The fully qualified Azure Resource manager identifier of the resource.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the BgpPeer.
The fully qualified Azure Resource manager identifier of the resource.
Optional Parameters
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>
.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
The name of the BgpPeer.
The fully qualified Azure Resource manager identifier of the resource.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI