Share via

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

  • Article

 

Applies To: Windows Azure Pack

Gets a static IP pool entity by using the HTTP GET operation.

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

  • Example: Read a specific static IP address pool

  • Example: Read all static IP address pools of a subnet

Request

For more information about returning multiple entities, see Common GET HTTP Info.

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

Method

Request URI

HTTP Version

GET

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

HTTP/1.1

GET

https://{server}:{auth-port}/{subscription-id}/services/systemcenter/vmm/StaticIPAddressPools

HTTP/1.1

Request URI Parameters

URI Parameter

Description

ID

[Edm.Guid] The identifier of the entity.

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 StaticIPAddressPool [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#StaticIPAddressPools/@Element",
   "EnableNetBIOS":false,
   "IsFullyCached":true,
   "IsIPv4":true,
   "IsMulticastPool":false,
   "IsViewOnly":false,
   "MarkedForDeletion":false,
   "ExternalSyncTime":null,
   "VLanID":0,
   "AvailableAddresses":"101",
   "AvailableDIPAddresses":"101",
   "AvailableVIPAddresses":"0",
   "ReservedAddresses":"0",
   "TotalAddresses":"101",
   "TotalDIPAddresses":"101",
   "TotalVIPAddresses":"0",
   "UnassignedAddresses":"0",
   "UnassignedDIPAddresses":"0",
   "UnassignedVIPAddresses":"0",
   "AddressFamily":"InterNetwork",
   "Description":"",
   "DNSSuffix":"",
   "IPAddressRangeEnd":"192.168.10.200",
   "IPAddressRangeStart":"192.168.10.100",
   "IPAddressReservedSet":"",
   "Name":"Default Pool",
   "Subnet":"192.168.10.0/24",
   "VIPAddressSet":"",
   "NetworkEntityAccessType":"VmmManaged",
   "DNSSearchSuffixes":[

   ],
   "DNSServers":[

   ],
   "WINSServers":[

   ],
   "DefaultGatewayIPAddresses":[

   ],
   "StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
   "ID":"e21d988c-801e-47b8-93f8-99dde9d3af08",
   "ExternalId":"e21d988c-801e-47b8-93f8-99dde9d3af08",
   "VMSubnetId":"5864052e-f83e-4c79-9a4b-1032e7020afa",
   "LogicalNetworkDefinitionId":null
}

Example: Read all static IP address pools of a subnet

This example reads all the static IP address pools available to the authenticated tenant.

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 networkSubnetId = new Guid("5864052e-f83e-4c79-9a4b-1032e7020afa");

var pools = vmmService.StaticIPAddressPools.Where(p => p.StampId == stampId && p.VMSubnetId == networkSubnetId).First();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/StaticIPAddressPools()?$filter=StampId%20eq%20guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc'%20and%20VMSubnetId%20eq%20guid'5864052e-f83e-4c79-9a4b-1032e7020afa'&$top=1 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: 1175
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-5e4b-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: Tue, 13 May 2014 23:03:13 GMT

{"odata.metadata":"https://waplabvm4.cdm.lab:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#StaticIPAddressPools","value":[{"EnableNetBIOS":false,"IsFullyCached":true,"IsIPv4":true,"IsMulticastPool":false,"IsViewOnly":false,"MarkedForDeletion":false,"ExternalSyncTime":null,"VLanID":0,"AvailableAddresses":"101","AvailableDIPAddresses":"101","AvailableVIPAddresses":"0","ReservedAddresses":"0","TotalAddresses":"101","TotalDIPAddresses":"101","TotalVIPAddresses":"0","UnassignedAddresses":"0","UnassignedDIPAddresses":"0","UnassignedVIPAddresses":"0","AddressFamily":"InterNetwork","Description":"","DNSSuffix":"","IPAddressRangeEnd":"192.168.10.200","IPAddressRangeStart":"192.168.10.100","IPAddressReservedSet":"","Name":"Default Pool","Subnet":"192.168.10.0/24","VIPAddressSet":"","NetworkEntityAccessType":"VmmManaged","DNSSearchSuffixes":[],"DNSServers":[],"WINSServers":[],"DefaultGatewayIPAddresses":[],"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"e21d988c-801e-47b8-93f8-99dde9d3af08","ExternalId":"e21d988c-801e-47b8-93f8-99dde9d3af08","VMSubnetId":"5864052e-f83e-4c79-9a4b-1032e7020afa","LogicalNetworkDefinitionId":null}]}

Example: Read a specific static IP address pool

This example reads a specific static IP address pool 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 staticIpAddressPoolId = new Guid("e21d988c-801e-47b8-93f8-99dde9d3af08");

SpfVMM.StaticIPAddressPool pool = vmmService.StaticIPAddressPools.Where(p => p.StampId == stampId && p.ID == staticIpAddressPoolId).First();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/StaticIPAddressPools(StampId=guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc',ID=guid'e21d988c-801e-47b8-93f8-99dde9d3af08') 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: 1172
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-ca4a-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: Tue, 13 May 2014 22:30:40 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#StaticIPAddressPools/@Element","EnableNetBIOS":false,"IsFullyCached":true,"IsIPv4":true,"IsMulticastPool":false,"IsViewOnly":false,"MarkedForDeletion":false,"ExternalSyncTime":null,"VLanID":0,"AvailableAddresses":"101","AvailableDIPAddresses":"101","AvailableVIPAddresses":"0","ReservedAddresses":"0","TotalAddresses":"101","TotalDIPAddresses":"101","TotalVIPAddresses":"0","UnassignedAddresses":"0","UnassignedDIPAddresses":"0","UnassignedVIPAddresses":"0","AddressFamily":"InterNetwork","Description":"","DNSSuffix":"","IPAddressRangeEnd":"192.168.10.200","IPAddressRangeStart":"192.168.10.100","IPAddressReservedSet":"","Name":"Default Pool","Subnet":"192.168.10.0/24","VIPAddressSet":"","NetworkEntityAccessType":"VmmManaged","DNSSearchSuffixes":[],"DNSServers":[],"WINSServers":[],"DefaultGatewayIPAddresses":[],"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"e21d988c-801e-47b8-93f8-99dde9d3af08","ExternalId":"e21d988c-801e-47b8-93f8-99dde9d3af08","VMSubnetId":"5864052e-f83e-4c79-9a4b-1032e7020afa","LogicalNetworkDefinitionId":null}

See Also

StaticIPAddressPools Collection [SPFSDK][VMMREF]
StaticIPAddressPool [SPFSDK][VMMREF]
Create (POST) a StaticIPAddressPool [SPFSDK][VMMREF]
Update (PUT) a StaticIPAddressPool [SPFSDK][VMMREF]
Delete (DELETE) a StaticIPAddressPool [SPFSDK][VMMREF]