GetARMPIP (AZURE Public IP)

This method is used to return the list of Azure public IPs in HCL BigFix CLM.

Method Signature:

GetARMPIP(regionName, pipName, controlId, async, servicePlanId, callback, addlparam)

Sample Response:

 [{"EntityID":"PIP-8B3D2A05-691A-4A05-A627-178BF631B5F6","PIPName":"xxxxPIP","ID":"5","PIPDNSName":"","IdleTimeOutInMin":"4","IsActive":"Y","IPAddress":"xxx.xx.x.xx","IPAllocationMethod":"Dynamic","IPAddressVersion":"IPv4","RegionName":"eastus","ActualIDOnEnvironment":"c04c3ba3-b2ec-4eb1-b4b1-9d562fbc9ee4","IsUsed":"Y","PlatformEntityID":"ARM-EF5CA4B6-67BE-4B48-BA7C-5F6FC4DAEA3E","text":"PIP"}]

Parameter Details:

Table 1. GetARMPIP
Parameter Name Type Mandatory Description
regionName String N

If region name is passed, then details of passed region’s Public IP are returned.

If blank “” is passed, then details of AZURE’s Public IP returns/bind to the control.
pipName String N

If Public IP is passed, then details of passed Public IP are returned.

If blank “” is passed, then details of AZURE’s Public IP is returned/bind to the control.
controlId String N

Id of “Select control” to be populated.

If Id Control of dynamic UI is passed, then control will be populated with values return from this function else “Result set” will be returned in JSON format.
async Boolean N

In case it’s False:

Function will be called in synchronous mode. i.e. Current execution will wait for method execution to complete

In case it’s True:

Function will be called asynchronously. Execution will not wait for method execution completion. It will jump to next statement.
servicePlanId String N Service Plan ID is a plan related to cost model created by provider and map to the resource in HCL BigFix CLM
callback Function N User can pass function name that can be executed on completion of Parent function call.
addlparam Object N

Addlparam is used for filtering and sorting the records. It contains 3 properties filter/sortby/sortorder.

To Filter:

To filter records based on column name received from output. e.g., filter="keyname='keyvalue'"

To Sort By:

To sort the data based on column name. e.g., sortby="keyname"

To Sort Order:

To define sorting order either ASC (Ascending) or DESC (descending). e.g., sortorder="ASC”