Get Disks

Table 1. API: GET AZURE Disks
Element Description
API GetAzureDisk
Description API returns AZURE disk(s) exist in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/azure/provisioningEndPoints/{endpointId}/disks
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=’eastus2’","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": "DISK-56A4468B-D729-4A6E-973D-F92A1E2E32D5",
 "diskName": "ASAtesting_disk1_a7414ac128e745bd90927ca34a4a3201(/subscriptions/3f853c29-f9c0-42b1-9fba-af6a407ded06/resourceGroups//providers/Microsoft.Compute/disks/ASAtesting_disk1_a7414ac128e745bd90927ca34a4a3201)",
 "uniqueId": "xxxxxx",
 "diskId": "/subscriptions/xxxxxx",
 "name": "ASAtesting_disk1_a7414ac128e745bd90927ca34a4a3201",
 "resourceGroupName": "",
 "location": "eastus2",
 "skuName": "Standard_LRS",
 "skuTier": "Standard",
 "osType": "Linux",
 "provisioningState": "Succeeded",
 "diskSizeGB": "32",
 "diskState": "Unattached",
 "createOption": "Copy",
 "imageReferenceId": "",
 "sourceResourceId": "/subscriptions/3f853c29-f9c0-42b1-9fba-af6a407ded06/resourceGroups//providers/Microsoft.Compute/snapshots/template_rhel-image-20191006163555_0_nchhklqewht",
 "diskIOPSReadWrite": "500",
 "diskMBpsReadWrite": "60",
 "encryptionType": "EncryptionAtRestWithPlatformKey",
 "diskSizeBytes": "34359738368",
 "platformEntityId": "ARM-58B227EC-707F-4549-9EB3-8EB1D06F55D2",
 "tags": [
 {
 "CreatedOn": "08/03/2021 17:06:13"
 }
 ],
 "associatedServicePlans": []
 }
 ]
}
Response Parameters
  • Result:
  • entityId
  • diskName
  • uniqueId
  • diskId
  • name
  • resourceGroupName
  • location
  • skuName
  • skuTier
  • osType
  • provisioningState
  • diskSizeGB
  • diskState
  • createOption
  • imageReferenceId
  • sourceResourceId
  • diskIOPSReadWrite
  • diskMBpsReadWrite
  • encryptionType
  • diskSizeBytes
  • platformEntityId
  • tags
  • associatedServicePlans