Get Public IPs

Table 1. API: GET AZURE Public Ips
Element Description
API GetAzurePIP
Description API returns AZURE public IP(s) addresses exist in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/azure/provisioningEndPoints/{endpointId}/publicIPs
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.
  • queryParams (Optional): It is used for filtering and sorting of records. It has three properties, which are as follows:
  • Filter: To filter records based on column name received from output. E.g. Filter="keyname='keyvalue'"
  • Sort Order: To define sorting order either ASC (Ascending) or DESC (descending). E.g. Sortorder="ASC".
  • Page Number: To get the records for related page number. Eg. Pagenumber="1”
  • Page Size: To get the number of records on selected page. Eg. Pagesize="10”
  • For e.g. 
    {"filter": "regionname=’eastus’","sortorder": "desc", "pagenumber”: "1", "pagesize" : "10"}
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:

{
 "totalRecords": 2,
 "records": [
 {
 "entityId": "PIP-59E00457-2E64-4718-9435-044833123D1E",
 "pipName": "LQA1024-ip",
 "pipDNSName": "",
 "regionName": "eastus",
 "id": 2,
 "idleTimeOutInMin": "4",
 "ipAddress": "xxxxxx",
 "ipAllocationMethod": "Dynamic",
 "ipAddressVersion": "IPv4",
 "actualIdOnEnvironment": "abe6f6df-a86a-4d77-94a7-457cf1a9bb12",
 "isUsed": "Y",
 "platformEntityId": "ARM-58B227EC-707F-4549-9EB3-8EB1D06F55D2",
 "tags": [
 {
 "EXPPIRY_x0020_DATE": "18-OCT-20"
 },
 {
 "Name": "Machine"
 },
 {
 "Owner": "AmitDw"
 },
 {
 "Purpose": "Performance_Data"
 },
 {
 "vmname": "LQA1024"
 },
 {
 "CreatedOn": "2022-01-18T04:33:32.4163145Z"
 }
 ],
 "associatedServicePlans": [
 {
 "servicePlanId": "2",
 "servicePlanName": "silver"
 }
 ]
 }
 ]
}
Response Parameters
  • Result:
  • entityId
  • pipName
  • pipDNSName
  • regionName
  • id
  • idleTimeOutInMin
  • ipAddress
  • ipAllocationMethod
  • ipAddressVersion
  • actualIdOnEnvironment
  • isUsed
  • platformEntityId
  • tags
  • associatedServicePlans