bgp_peers

Creates, updates, deletes, gets or lists a bgp_peers resource.

Overview

Name	bgp_peers
Type	Resource
Id	azure.k8s_runtime.bgp_peers

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceUri, bgpPeerName		Get a BgpPeer
list	select	resourceUri		List BgpPeer resources by parent
create_or_update	insert	resourceUri, bgpPeerName		Create a BgpPeer
delete	delete	resourceUri, bgpPeerName		Delete a BgpPeer

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bgpPeerName	string	The name of the BgpPeer
resourceUri	string	The fully qualified Azure Resource manager identifier of the resource.

SELECT examples

get

Get a BgpPeer

SELECT
properties
FROM azure.k8s_runtime.bgp_peers
WHERE resourceUri = '{{ resourceUri }}' -- required
AND bgpPeerName = '{{ bgpPeerName }}' -- required
;

list

List BgpPeer resources by parent

SELECT
properties
FROM azure.k8s_runtime.bgp_peers
WHERE resourceUri = '{{ resourceUri }}' -- required
;

INSERT examples

create_or_update

Create a BgpPeer

INSERT INTO azure.k8s_runtime.bgp_peers (
data__properties,
resourceUri,
bgpPeerName
)
SELECT 
'{{ properties }}',
'{{ resourceUri }}',
'{{ bgpPeerName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: bgp_peers
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the bgp_peers resource.
    - name: bgpPeerName
      value: string
      description: Required parameter for the bgp_peers resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete a BgpPeer

DELETE FROM azure.k8s_runtime.bgp_peers
WHERE resourceUri = '{{ resourceUri }}' --required
AND bgpPeerName = '{{ bgpPeerName }}' --required
;