Get Network Profile

Get Network Profile

Returns the network profile associated with the given id.

Request
URI
GET
https://{api_host}/iaas-proxy-provider/api/network/profiles/{id}
COPY
Path Parameters
string
id
Required

The id of the network profile.


Responses
200

The network profile is retrieved.

Returns NetworkProfile of type(s) */*
{
    "definedAddresses": [
        {
            "hostName": "string",
            "virtualMachineId": "string",
            "virtualMachineName": "string",
            "lastModifiedDate": "string",
            "stateValue": 0,
            "description": "string",
            "networkProfileId": "string",
            "IPv4Address": "string",
            "IPSortValue": 0,
            "createdDate": "string",
            "staticIPv4RangeId": "string",
            "networkInterfaceCardOffset": "string",
            "name": "string",
            "id": "string",
            "state": "string"
        }
    ],
    "IPAMEndpointName": "string",
    "lastModifiedDate": "string",
    "reclaimedAddresses": [
        {
            "hostName": "string",
            "virtualMachineId": "string",
            "virtualMachineName": "string",
            "lastModifiedDate": "string",
            "stateValue": 0,
            "description": "string",
            "networkProfileId": "string",
            "IPv4Address": "string",
            "IPSortValue": 0,
            "createdDate": "string",
            "staticIPv4RangeId": "string",
            "networkInterfaceCardOffset": "string",
            "name": "string",
            "id": "string",
            "state": "string"
        }
    ],
    "description": "string",
    "isHidden": false,
    "createdDate": "string",
    "profileType": "string",
    "definedRanges": [
        {
            "endIPv4Address": "string",
            "definedAddresses": [
                {
                    "hostName": "string",
                    "virtualMachineId": "string",
                    "virtualMachineName": "string",
                    "lastModifiedDate": "string",
                    "stateValue": 0,
                    "description": "string",
                    "networkProfileId": "string",
                    "IPv4Address": "string",
                    "IPSortValue": 0,
                    "createdDate": "string",
                    "staticIPv4RangeId": "string",
                    "networkInterfaceCardOffset": "string",
                    "name": "string",
                    "id": "string",
                    "state": "string"
                }
            ],
            "createdDate": "string",
            "lastModifiedDate": "string",
            "name": "string",
            "description": "string",
            "externalId": "string",
            "id": "string",
            "state": "string",
            "networkProfileId": "string",
            "gateway": "string",
            "beginIPv4Address": "string"
        }
    ],
    "name": "string",
    "id": "string",
    "IPAMEndpointId": "string",
    "addressSpaceExternalId": "string"
}
definedAddresses
Optional

definedAddresses

string
IPAMEndpointName
Optional

IPAMEndpointName

string As date-time As date-time
lastModifiedDate
Optional

lastModifiedDate

reclaimedAddresses
Optional

reclaimedAddresses

string
description
Optional

description

boolean
isHidden
Optional

isHidden

string As date-time As date-time
createdDate
Optional

createdDate

string
profileType
Optional

profileType

Possible values are : EXTERNAL, PRIVATE, NAT, ROUTED,
definedRanges
Optional

definedRanges

string
name
Required

name

string
id
Optional

id

string
IPAMEndpointId
Optional

IPAMEndpointId

string
addressSpaceExternalId
Optional

addressSpaceExternalId