BGPPeer [SPFSDK][VMMREF]

 

Applies To: Windows Azure Pack

The BGPPeer entity represents a Border Gateway Protocol (BGP) peer for Virtual Machine Manager (VMM).

Inheritance Hierarchy

VMM
  BGPPeer

Entity Properties

For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.

When querying the BGPPeers Collection [SPFSDK][VMMREF] collection using the HTTP GET operation, you must pass the StampId property along with either the ID or VMNetworkGatewayId property. See Read (GET) a BGPPeer [SPFSDK][VMMREF] for more information.

Name	Create (POST)	Read (GET)	Update (PUT)	Delete (DELETE)	Type	Nullable	Description
ID	-	Required	-	Required	Edm.Guid	False	Key Property The identifier of the entity.
StampId	Required	Required	-	Required	Edm.Guid	False	Key Property The identifier of the stamp that contains the entity.
Description	Optional	Optional	-	-	Edm.String	True	The description of the peer.
Name	Optional	Optional	-	-	Edm.String	True	The name of the peer.
PeerASN	Required	Optional	-	-	Edm.Int64	True	The Autonomous System Number (ASN) of the peer.
PeerIPAddress	Required	Optional	-	-	Edm.String	True	The IP address of the peer.
VMNetworkGatewayId	Required	Required	-	-	Edm.Guid	True	The identifier of the virtual machine network gateway.

Relationships

None

OData Operations

None

Examples

• Example: Create a new BGPPeer

• Example: Delete an existing BGP peer

• Example: Read a BGP peer

• Example: Read the BGP peer by the associated VM network gateway

See Also

Entities [SPFSDK][VMMREF]
BGPPeers Collection [SPFSDK][VMMREF]
VMNetworkGateway [SPFSDK][VMMREF]