Get Nics

Table 1. API: GET AZURE Nics
Element Description
API GetAzureNIC
Description API returns AZURE nic(s) exist in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/azure/provisioningEndPoints/{endpointId}/nics
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": "location=’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": "NIC-BC527C6B-D032-4735-B079-B925430D7651",
 "nicName": "lqa1024216(/subscriptions/3f853c29-f9c0-42b1-9fba-af6a407ded06/resourceGroups/RG/providers/Microsoft.Network/networkInterfaces/lqa1024216)",
 "name": "lqa1024216",
 "nicId": "/subscriptions/3f853c29-f9c0-42b1-9fba-af6a407ded06/resourceGroups/RG/providers/Microsoft.Network/networkInterfaces/lqa1024216",
 "resourceGuid": "9d099716-2d76-4c0e-a829-e87df71c7479",
 "resourceGroupName": "RG",
 "location": "eastus",
 "provisioningState": "Succeeded",
 "nicType": "Standard",
 "macAddress": "xxxxxx",
 "virtualMachineId": "/subscriptions/xxxxxx",
 "networkSecurityGroup": "",
 "enableAcceleratedNetworking": "false",
 "enableIpForwarding": "false",
 "primary": "true",
 "platformEntityId": "ARM-58B227EC-707F-4549-9EB3-8EB1D06F55D2",
 "associatedServicePlans": [
 {
 "servicePlanId": "2",
 "servicePlanName": "silver"
 }
 ]
 }
 ]
}
Response Parameters
  • Result:
  • entityId
  • nicName
  • name
  • nicId
  • resourceGuid
  • resourceGroupName
  • location
  • provisioningState
  • nicType
  • macAddress
  • virtualMachineId
  • networkSecurityGroup
  • enableAcceleratedNetworking
  • enableIpForwarding
  • primary
  • platformEntityId
  • associatedServicePlans