Ip Pools - List

Returns a list of all IP pools at a certain location.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/ipPools?api-version=2016-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/ipPools?api-version=2016-05-01&$filter={$filter}

URI Parameters

Name In Required Type Description
location
path True

string

Location of the resource.

resourceGroupName
path True

string

Name of the resource group.

subscriptionId
path True

string

Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API Version.

$filter
query

string

OData filter parameter.

Responses

Name Type Description
200 OK

IpPoolList

OK

404 Not Found

NOT FOUND

Security

azure_auth

Authorization uses an Azure Active Directory OAuth2 flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Returns a list of all IP pools at a certain location.

Sample Request

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools?api-version=2016-05-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools/13ff1d24-17e5-4a95-a4b2-f3ec7ceaafb1",
      "name": "13ff1d24-17e5-4a95-a4b2-f3ec7ceaafb1",
      "type": "Microsoft.Fabric.Admin/fabricLocations/ipPools",
      "location": "local",
      "tags": {},
      "properties": {
        "startIpAddress": "192.168.200.1",
        "endIpAddress": "192.168.200.62",
        "numberOfIpAddresses": 62,
        "numberOfAllocatedIpAddresses": 3,
        "numberOfIpAddressesInTransition": 0
      }
    },
    {
      "id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools/7d78b1d4-059d-4956-bd08-a174ef5db6ae",
      "name": "7d78b1d4-059d-4956-bd08-a174ef5db6ae",
      "type": "Microsoft.Fabric.Admin/fabricLocations/ipPools",
      "location": "local",
      "tags": {},
      "properties": {
        "startIpAddress": "192.168.105.1",
        "endIpAddress": "192.168.105.255",
        "numberOfIpAddresses": 255,
        "numberOfAllocatedIpAddresses": 8,
        "numberOfIpAddressesInTransition": 0
      }
    },
    {
      "id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools/acd04be9-69fe-4713-99d3-99046f971f73",
      "name": "acd04be9-69fe-4713-99d3-99046f971f73",
      "type": "Microsoft.Fabric.Admin/fabricLocations/ipPools",
      "location": "local",
      "tags": {},
      "properties": {
        "startIpAddress": "192.168.200.65",
        "endIpAddress": "192.168.200.111",
        "numberOfIpAddresses": 47,
        "numberOfAllocatedIpAddresses": 0,
        "numberOfIpAddressesInTransition": 0
      }
    },
    {
      "id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools/cace184f-12a4-43a7-ab22-9796cda85c56",
      "name": "cace184f-12a4-43a7-ab22-9796cda85c56",
      "type": "Microsoft.Fabric.Admin/fabricLocations/ipPools",
      "location": "local",
      "tags": {},
      "properties": {
        "startIpAddress": "192.168.200.112",
        "endIpAddress": "192.168.200.127",
        "numberOfIpAddresses": 16,
        "numberOfAllocatedIpAddresses": 1,
        "numberOfIpAddressesInTransition": 0
      }
    },
    {
      "id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools/cf9ccfbf-d902-44ef-914c-3e59c2cc5215",
      "name": "cf9ccfbf-d902-44ef-914c-3e59c2cc5215",
      "type": "Microsoft.Fabric.Admin/fabricLocations/ipPools",
      "location": "local",
      "tags": {},
      "properties": {
        "startIpAddress": "192.168.200.224",
        "endIpAddress": "192.168.200.254",
        "numberOfIpAddresses": 31,
        "numberOfAllocatedIpAddresses": 1,
        "numberOfIpAddressesInTransition": 0
      }
    },
    {
      "id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools/e7eb5792-8240-4210-8f25-73cf2d0be74a",
      "name": "e7eb5792-8240-4210-8f25-73cf2d0be74a",
      "type": "Microsoft.Fabric.Admin/fabricLocations/ipPools",
      "location": "local",
      "tags": {},
      "properties": {
        "startIpAddress": "192.168.102.1",
        "endIpAddress": "192.168.102.255",
        "numberOfIpAddresses": 255,
        "numberOfAllocatedIpAddresses": 33,
        "numberOfIpAddressesInTransition": 0
      }
    },
    {
      "id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools/TestIpPool199198",
      "name": "TestIpPool199198",
      "type": "Microsoft.Fabric.Admin/fabricLocations/ipPools",
      "location": "local",
      "tags": {},
      "properties": {
        "startIpAddress": "192.198.9.1",
        "endIpAddress": "192.198.9.255",
        "numberOfIpAddresses": 255,
        "numberOfAllocatedIpAddresses": 0,
        "numberOfIpAddressesInTransition": 0
      }
    },
    {
      "id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools/TestIpPool1992",
      "name": "TestIpPool1992",
      "type": "Microsoft.Fabric.Admin/fabricLocations/ipPools",
      "location": "local",
      "tags": {},
      "properties": {
        "startIpAddress": "192.2.9.1",
        "endIpAddress": "192.2.9.255",
        "numberOfIpAddresses": 255,
        "numberOfAllocatedIpAddresses": 0,
        "numberOfIpAddressesInTransition": 0
      }
    },
    {
      "id": "/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/ipPools/TestIpPool1993",
      "name": "TestIpPool1993",
      "type": "Microsoft.Fabric.Admin/fabricLocations/ipPools",
      "location": "local",
      "tags": {},
      "properties": {
        "startIpAddress": "192.3.9.1",
        "endIpAddress": "192.3.9.255",
        "numberOfIpAddresses": 255,
        "numberOfAllocatedIpAddresses": 0,
        "numberOfIpAddressesInTransition": 0
      }
    }
  ]
}

Definitions

Name Description
IpPool

This resource defines the range of IP addresses from which addresses are allocated for nodes within a subnet.

IpPoolList

Pageable list of IP pools.

IpPool

This resource defines the range of IP addresses from which addresses are allocated for nodes within a subnet.

Name Type Description
id

string

URI of the resource.

location

string

The region where the resource is located.

name

string

Name of the resource.

properties.addressPrefix

string

The address prefix.

properties.endIpAddress

string

The ending IP address.

properties.numberOfAllocatedIpAddresses

integer

The number of currently allocated IP addresses.

properties.numberOfIpAddresses

integer

The total number of IP addresses.

properties.numberOfIpAddressesInTransition

integer

The current number of IP addresses in transition.

properties.startIpAddress

string

The starting IP address.

tags

object

List of key-value pairs.

type

string

Type of resource.

IpPoolList

Pageable list of IP pools.

Name Type Description
nextLink

string

URI to the next page.

value

IpPool[]

List of IP pools.