bgp_peers

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

Overview

Name	bgp_peers
Type	Resource
Id	azure.container_orchestrator_runtime.bgp_peers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
myAsn	integer	My ASN. Required.
peerAddress	string	Peer Address. Required.
peerAsn	integer	Peer ASN. Required.
provisioningState	string	Resource provision state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
myAsn	integer	My ASN. Required.
peerAddress	string	Peer Address. Required.
peerAsn	integer	Peer ASN. Required.
provisioningState	string	Resource provision state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_uri, bgp_peer_name		Get a BgpPeer.
list	select	resource_uri		List BgpPeer resources by parent.
create_or_update	insert	resource_uri, bgp_peer_name		Create a BgpPeer.
create_or_update	replace	resource_uri, bgp_peer_name		Create a BgpPeer.
delete	delete	resource_uri, bgp_peer_name		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
bgp_peer_name	string	The name of the BgpPeer. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Get a BgpPeer.

SELECT
id,
name,
myAsn,
peerAddress,
peerAsn,
provisioningState,
systemData,
type
FROM azure.container_orchestrator_runtime.bgp_peers
WHERE resource_uri = '{{ resource_uri }}' -- required
AND bgp_peer_name = '{{ bgp_peer_name }}' -- required
;

list

List BgpPeer resources by parent.

SELECT
id,
name,
myAsn,
peerAddress,
peerAsn,
provisioningState,
systemData,
type
FROM azure.container_orchestrator_runtime.bgp_peers
WHERE resource_uri = '{{ resource_uri }}' -- required
;

INSERT examples

create_or_update

Create a BgpPeer.

INSERT INTO azure.container_orchestrator_runtime.bgp_peers (
properties,
resource_uri,
bgp_peer_name
)
SELECT 
'{{ properties }}',
'{{ resource_uri }}',
'{{ bgp_peer_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: bgp_peers
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    description: Required parameter for the bgp_peers resource.
  - name: bgp_peer_name
    value: "{{ bgp_peer_name }}"
    description: Required parameter for the bgp_peers resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      myAsn: {{ myAsn }}
      peerAsn: {{ peerAsn }}
      peerAddress: "{{ peerAddress }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create a BgpPeer.

REPLACE azure.container_orchestrator_runtime.bgp_peers
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND bgp_peer_name = '{{ bgp_peer_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a BgpPeer.

DELETE FROM azure.container_orchestrator_runtime.bgp_peers
WHERE resource_uri = '{{ resource_uri }}' --required
AND bgp_peer_name = '{{ bgp_peer_name }}' --required
;