Get IP Configuration

Table 1. API: GET AZURE Ip Configurations
Element Description
API GetAzureIPConfigurations
Description API returns AZURE Ipconfiguration(s) exist in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/azure/provisioningEndPoints/{endpointId}/ipConfigurations
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": "nicname=’HCL BigFix CLM win264’","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": 1,
 "records": [
 {
 "entityId": "IPCONFIG-005C82F4-E10E-4B74-9C31-D0FAE8CE8DA7",
 "nicName": "HCL BigFix CLMwin264",
 "name": "RG",
 "nicResourceGuid": "45cd71b4-94f2-422e-86b2-edf8a021ecbc",
 "ipConfigurationId": "W/\"10ee5e17-2c7a-4858-b5a2-5379c6eaa917\"",
 "resourceGroupName": "/subscriptions/3f853c29-f9c0-42b1-9fba-af6a407ded06/resourceGroups/RG/providers/Microsoft.Network/networkInterfaces/win264/ipConfigurations/ipconfig1",
 "eTag": "Succeeded",
 "privateIpAddress": "Dynamic",
 "privateIpAllocationMethod": "/subscriptions/3f853c29-f9c0-42b1-9fba-af6a407ded06/resourceGroups/RG/providers/Microsoft.Network/virtualNetworks/RG-vnet/subnets/common-sub",
 "subnetId": "true",
 "primary": "IPv4",
 "enableIpForwarding": "",
 "platformEntityId": "ARM-58B227EC-707F-4549-9EB3-8EB1D06F55D2"
 }
 ]
}
Response Parameters
  • Result:
  • entityId
  • nicName
  • name
  • nicResourceGuid
  • ipConfigurationId
  • resourceGroupName
  • eTag
  • privateIpAddress
  • privateIpAllocationMethod
  • subnetId
  • primary
  • enableIpForwarding
  • platformEntityId