Reserve Azure Ips

Table 1. API: Reserve AZURE Ips
Element Description
API ReserveAndGetAzureFreeIpDetails
Description This API Reserves and returns IPaddress for an object i.e. IP will be blocked in passed subnet.
Method POST
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/azure/provisioningEndPoints/{endpointId}/subnets/{subnetEntityId}/freeIps
URL Parameters (fields in curly {} braces)
  • endpointId (Mandatory): This is a unique identifier of Cloud Endpoint created in HCL BigFix CLM. It can be any value either PlatformEntityId or Name of the Platform available on Manage Provisioning Platform screen.
  • subnetEntityId (Mandatory): This parameter represents the subnet entity id for which IPs are to be fetched.
Body Parameters 
{
"ObjectID": "",
"NICPrefix": ""
}
Header
  • Authorization Key: The initial step that needs to be performed before consuming HCL BigFix CLM API is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
  • Content-type: application/json
Response

A Sample Response:

{
 "subnetName": "test",
 "ipAddress": "xxxxxx",
 "subnetMask": "xxxxxx",
 "defaultGateway": "xxxxxx",
 "networkType": "NET_T1"
}
Response Parameters
  • Result:
  • SubnetName
  • ipAddress
  • subnetmask
  • defaultGateway
  • networkType