Update Or Create Network Profile

• Network Profile

Updates an existing NetworkProfile.

Request

URI

PUT

https://{api_host}/iaas-proxy-provider/api/network/profiles/{id}

COPY

Path Parameters

string

id

Required

The unique identifier for the network profile.

---

Request Body

The network profile to be updated.

NetworkProfile of type(s) application/json

Required

{
    "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"
}

array of StaticIPv4Address

definedAddresses

Optional

definedAddresses

string

IPAMEndpointName

Optional

IPAMEndpointName

string As date-time As date-time

lastModifiedDate

Optional

lastModifiedDate

array of StaticIPv4Address

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,

array of StaticIPv4Range

definedRanges

Optional

definedRanges

string

name

Required

name

string

id

Optional

id

string

IPAMEndpointId

Optional

IPAMEndpointId

string

addressSpaceExternalId

Optional

addressSpaceExternalId

Responses

200

Hide Details

successful operation

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"
}

array of StaticIPv4Address

definedAddresses

Optional

definedAddresses

string

IPAMEndpointName

Optional

IPAMEndpointName

string As date-time As date-time

lastModifiedDate

Optional

lastModifiedDate

array of StaticIPv4Address

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,

array of StaticIPv4Range

definedRanges

Optional

definedRanges

string

name

Required

name

string

id

Optional

id

string

IPAMEndpointId

Optional

IPAMEndpointId

string

addressSpaceExternalId

Optional

addressSpaceExternalId

204

Hide Details

The network profile is updated.

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"
}

array of StaticIPv4Address

definedAddresses

Optional

definedAddresses

string

IPAMEndpointName

Optional

IPAMEndpointName

string As date-time As date-time

lastModifiedDate

Optional

lastModifiedDate

array of StaticIPv4Address

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,

array of StaticIPv4Range

definedRanges

Optional

definedRanges

string

name

Required

name

string

id

Optional

id

string

IPAMEndpointId

Optional

IPAMEndpointId

string

addressSpaceExternalId

Optional

addressSpaceExternalId

On This Page

Description

Request

Path Parameters

Request Body

Response

200 Response Body

204 Response Body

Network Profile Operations

POST

Create Network Profile

DELETE

Delete Network Profile

GET

Get Network Profile

GET

Get Network Profile Addresses

GET

Get Network Profile Range Summaries

GET

List Network Profile

GET

List Network Profile For Tenant

PUT

Update Or Create Network Profile