List Networks

List Networks

Returns a collection of networks with specified paging, sorting and filtering parameters

Request
URI
GET
https://{api_host}/network-service//api/networks
COPY
Query Parameters
integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response

Request Body
PageAndSortRequest2 of type(s) application/json
Optional 
{
    "pageNumber": 0,
    "offset": 0,
    "pageSize": 0,
    "queryInfo": {
        "expand": [
            {
                "propertyName": "string"
            }
        ],
        "select": [
            {
                "propertyName": "string"
            }
        ],
        "top": 0,
        "skipToken": "string",
        "inlineCount": "string",
        "orderBy": [
            {
                "direction": "string"
            }
        ],
        "skip": 0,
        "rawFilter": "string",
        "rawOrderBy": "string"
    }
}
integer As int32 As int32
pageNumber
Optional

pageNumber

integer As int32 As int32
offset
Optional

offset

integer As int32 As int32
pageSize
Optional

pageSize

Sort
sort
Optional

sort

OdataQueryInfo
queryInfo
Optional

queryInfo

Responses
200

successful operation

Returns PageNetwork of type(s) */* 
{
    "number": 0,
    "size": 0,
    "last": false,
    "numberOfElements": 0,
    "totalPages": 0,
    "content": [
        {
            "networkBackings": [
                {
                    "computeResourceName": "string",
                    "externalId": "string",
                    "id": "string",
                    "computeResourceNetworkId": "string",
                    "computeResourceId": "string",
                    "extensionData": {
                        "entries": [
                            {
                                "key": "string"
                            }
                        ]
                    }
                }
            ],
            "machineIdCollection": [
                "string"
            ],
            "name": "string",
            "tenantId": "string",
            "description": "string",
            "externalId": "string",
            "networkTypeId": "string",
            "networkProfileType": "string",
            "id": "string",
            "natRules": [
                {
                    "networkInterfaceId": "string",
                    "translatedAddress": "string",
                    "componentId": "string",
                    "userDefined": false,
                    "externalId": "string",
                    "description": "string",
                    "targetType": "string",
                    "type": "string",
                    "enabled": false,
                    "protocol": "string",
                    "edgeId": "string",
                    "machineId": "string",
                    "originalAddress": "string",
                    "name": "string",
                    "peerInterfaceIndex": 0,
                    "action": "string",
                    "translatedPort": "string",
                    "interfaceIndex": 0,
                    "id": "string",
                    "tag": "string",
                    "componentName": "string",
                    "order": 0,
                    "originalPort": "string"
                }
            ],
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ],
    "first": false,
    "totalElements": 0
}
integer As int32 As int32
number
Optional

number

integer As int32 As int32
size
Optional

size

boolean
last
Optional

last

integer As int32 As int32
numberOfElements
Optional

numberOfElements

integer As int32 As int32
totalPages
Optional

totalPages

Sort
sort
Optional

sort

array of Network
content
Optional

content

boolean
first
Optional

first

integer As int64 As int64
totalElements
Optional

totalElements


On This Page
Network Component Operations
POST
Add A list Of security policies To An on-demand security group
POST
Apply To Machine Security Tags
POST
Assign the security group To the specified machine(s)
POST
Create Network
POST
Create Security Group
DELETE
Delete Network
DELETE
Delete Security Group
GET
Get Load Balancer
GET
Get Network
GET
Get Security Group
GET
Get Security Policy
GET
Get Security Tags
GET
List Load Balancers
GET
List Networks
GET
List Security Groups
GET
List Security Groups For Tenant
GET
List Security Policy
GET
List Security Policy For Tenant
GET
List Security Tags
GET
List Security Tags For Tenant
PUT
Update Security Group
PUT
Update Security Policy
PUT
Update Security Tag