Get SQL Databases

Table 1. API: GET AZURE Project(SQL Databases)
Element Description
API GetArmSqlDatabases
Description API returns Azure project(SQL Databases).
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/azure/provisioningEndPoints/{endpointId}/sqlDatabase
URL Parameters (fields in curly {} braces)
  • endpointId(Mandatory): endpointId
  • queryParams (Optional): It is used for filtering and sorting 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":
 "code=’HDD’","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 to the Token API description.
  • Content-type: application/json
Response

A Sample Response: 

 { 
 "totalRecords": 1, 
 "records": [ 
 { 
 "sqlDatabaseName": "string", 
 "kind": "string", 
 "collation": "string", 
 "maxSizeBytes": "string", 
 "status": "string", 
 "databaseId": "string", 
 "currentServiceObjectiveName": "string", 
 "requestedServiceObjectiveName": "string", 
 "defaultSecondaryLocation": "string", 
 "catalogCollation": "string", 
 "zoneRedundant": "string", 
 "readScale": "string", 
 "currentSkuname": "string", 
 "currentSkutier": "string", 
 "currentSkucapacity": "string", 
 "currentBackupStorageRedundancy": "string", 
 "requestedBackupStorageRedundancy": "string", 
 "maintenanceConfigurationId": "string", 
 "isLedgerOn": "string", 
 "isInfraEncryptionEnabled": "string", 
 "entityId": "string", 
 "description": "string", 
 "type": "string", 
 "location": "string", 
 "tags": "string", 
 "skuName": "string", 
 "skuFamily": "string", 
 "skuCapacity": "string", 
 "platformEntityId": "string", 
 "associatedServicePlans": [ 
 { 
 "servicePlanId": "string", 
 "servicePlanName": "string" 
 } 
 ] 
 } 
 ] 
 }
Response Parameters
  • Result:
    • sqlDatabaseName
    • kind
    • collation
    • maxSizeBytes
    • status
    • databaseId
    • currentServiceObjectiveName
    • requestedServiceObjectiveName
    • defaultSecondaryLocation
    • catalogCollation
    • zoneRedundant
    • readScale
    • currentSkuname
    • currentSkutier
    • currentSkucapacity
    • currentBackupStorageRedundancy
    • requestedBackupStorageRedundancy
    • maintenanceConfigurationId
    • isLedgerOn
    • isInfraEncryptionEnabled
    • entityId
    • description
    • type
    • location
    • tags
    • skuName
    • skuFamily
    • skuCapacity
    • platformEntityId
    • associatedServicePlans
    • updateChannel
    • disableAccessKeyAuthentication
    • entityId
    • description
    • type
    • location
    • tags
    • skuName
    • skuFamily
    • skuCapacity
    • platformEntityId
    • associatedServicePlans