GetARMRegion (Azure Regions)

This method is used to return the list of regions of Azure provisioning platform created in HCL BigFix CLM.

Method Signature:

GetARMRegion(regionName, controlId, async, callback, addlparam)

Sample Response:

 [{"RegionEntityID":"REG-11994DF6-7063-4FED-9F9A-264CC6F6069E",
"RegionName":"eastus","ID":"4","IsActive":"Y","CityName":"","Longitude":"-79.8164","Latitude":"37.3719",
"DisplayName":"East US","Createdby":"","CreatedDate":"4/18/2019 10:25:20 AM","ModifyBy":"","ModifiedDate":"","IsDeleted":"N","IsSynced":"N","PlatFormCode":"ARM","text":"eastus"}]

Parameter Details:

Table 1. GetARMRegion (Azure Regions)
Parameter Name Type Mandatory Description
RegionName String N

If region name is passed, then details of the passed region will return.

If blank “” is passed in this field, then all regions of end point will return.
controlId String N

Id of “Select control” to be populated.

If Id of 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 is False:

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

In case it is True:

Function will be called asynchronously. Execution will not wait for method execution completion. It will jump to the next statement.
callback Function N User can pass function name that can get 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”