Share via

Read (GET) a BGPPeer [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

Read a BGPPeer [SPFSDK][VMMREF] entity using the HTTP GET operation.

Here is a list of examples related to this collection operation.

  • Example: Read a BGP peer

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

Request

For more information about the variables used in the URI, see URL placeholders.

The BGPPeers Collection [SPFSDK][VMMREF] does not allow you to retrieve all instances. You may only either query for a BGP peer by its identifier or by the identifier of the related VM network gateway object.

Method

Request URI

HTTP Version

GET

https://{server}:{auth-port}/{subscription-id}/services/systemcenter/vmm/BGPPeers(ID=Guid'[value]',StampId=Guid'[value]')

HTTP/1.1

Request URI Parameters

URI Parameter

Description

ID

[Edm.Guid] The identifier of the object to delete.

StampId

[Edm.Guid] The identifier of the stamp that restricts the query.

Request Headers

This operation does not use any non-standard request headers.

For more information about the common request headers used by this operation, see Common HTTP request information.

Request Body

None

Response

Response Codes

This operation does not return any non-standard OData response codes. If successful, it will return code 200 OK.

Response Headers

This operation does not use any non-standard response headers.

For more information about the common response headers used by this operation, see Common HTTP response information.

Response Body

The response body will contain either (depending on the request headers) an XML or JSON encoded BGPPeer [SPFSDK][VMMREF] entity or entities. Here is the response body of a single entity.

{
   "odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#BGPPeers/@Element",
   "StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
   "ID":"6d507ad6-d1c6-458a-9104-a668da0ca8b7",
   "VMNetworkGatewayId":null,
   "Name":"192.168.1.123",
   "Description":null,
   "PeerIPAddress":"192.168.1.123",
   "PeerASN":"2"
}

Example: Read a BGP peer

This example reads a single BGP peer by identifier.

For more information about how to get started with using the code examples provided in this programming guide, see Program in Visual Studio with the Windows Azure Pack IaaS Resource Provider [SPFSDK].

Guid stampId = new Guid("56ebc6dc-f63c-46e2-8438-2967e0ad83bc");
Guid peerId = new Guid("6d507ad6-d1c6-458a-9104-a668da0ca8b7");

var peer = vmmService.BGPPeers.Where(b => b.StampId == stampId && b.ID == peerId).First();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/BGPPeers(StampId=guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc',ID=guid'6d507ad6-d1c6-458a-9104-a668da0ca8b7') HTTP/1.1
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
DataServiceUrlConventions: KeyAsSegment
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer {ENCODED AUTHENTICATION TOKEN}
x-ms-principal-id: tenant@fabrikam.com
Host: contoso.com:30005

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 350
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: 5fbd8ef2-63e6-0000-3b86-bf5fe663cf01
DataServiceVersion: 3.0;
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-Powered-By: ASP.NET
Date: Thu, 15 May 2014 02:30:28 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#BGPPeers/@Element","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"6d507ad6-d1c6-458a-9104-a668da0ca8b7","VMNetworkGatewayId":null,"Name":"192.168.1.123","Description":null,"PeerIPAddress":"192.168.1.123","PeerASN":"2"}

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

This example queries the BGPPeers collection for any BGP peers assigned to a specific VM network gateway.

For more information about how to get started with using the code examples provided in this programming guide, see Program in Visual Studio with the Windows Azure Pack IaaS Resource Provider [SPFSDK].

Guid stampId = new Guid("56ebc6dc-f63c-46e2-8438-2967e0ad83bc");
Guid gatewayId = new Guid("6c5af99d-140b-4a6b-9329-059ef118bbbb");

var peers = vmmService.BGPPeers.Where(b => b.StampId == stampId && b.VMNetworkGatewayId == gatewayId).ToList();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/BGPPeers()?$filter=StampId%20eq%20guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc'%20and%20VMNetworkGatewayId%20eq%20guid'6c5af99d-140b-4a6b-9329-059ef118bbbb' HTTP/1.1
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
DataServiceUrlConventions: KeyAsSegment
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer {ENCODED AUTHENTICATION TOKEN}
x-ms-principal-id: tenant@fabrikam.com
Host: contoso.com:30005

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 353
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: 5fbd8ef2-63e6-0000-3586-bf5fe663cf01
DataServiceVersion: 3.0;
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-Powered-By: ASP.NET
Date: Thu, 15 May 2014 02:29:55 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#BGPPeers","value":[{"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"6d507ad6-d1c6-458a-9104-a668da0ca8b7","VMNetworkGatewayId":null,"Name":"192.168.1.123","Description":null,"PeerIPAddress":"192.168.1.123","PeerASN":"2"}]}

See Also

BGPPeers Collection [SPFSDK][VMMREF]
BGPPeer [SPFSDK][VMMREF]
Create (POST) a BGPPeer [SPFSDK][VMMREF]
Delete (DELETE) a BGPPeer [SPFSDK][VMMREF]