Returns a list of Azure connectors that match the provided criteria.
Limit your results -Narrow down your search results using the parameters listed below.
Pagination - A maximum of 100 instances are returned by default. To customize this specify a "preferences" tag in the POST body of your request.
|
Parameter |
Mandatory /Optional |
Data Type |
Description |
|---|---|---|---|
|
id |
The ID of the connector that you want to search. |
||
|
name |
Name is the name for the connector you want to search. |
||
|
description |
Description of the connector you want to search. |
||
|
lastSync |
Last sync date of the connector |
||
|
connectorState |
State of the connector. States include PENDING, SUCCESS, ERROR, QUEUED, RUNNING, PROCESSING, FINISHED_SUCCESS, FINISHED_ERRORS, DISABLED, INCOMPLETE. |
||
|
Type |
Type of connector- Azure |
||
|
authrecord.applicationId |
Unique identifier of the application you create on Azure portal. |
||
|
authrecord.directoryId |
Unique identifier of your Azure Active Directory. |
||
|
activation |
Activation of Qualys modules. Includes VM, PC, SCA, CERTVIEW |
||
|
authrecord.subscriptionId |
Unique identifier of your Microsoft Azure subscription. |
||
|
appCapability.name |
Connector application capability name |
||
|
appCapability.tag.name |
Tag name associates with Connector identifier. |
||
|
disabled |
boolean |
Whether execution of the connector is disabled (YES). If disabled, the connector does not synchronize assets. |
|
|
defaultTags.name |
The name of a tag in the defaultTags collection. |
||
|
defaultTag |
Integer |
The ID of a tag in the defaultTags collection. |
|
|
lastError |
Last error date of the connector. |
API request
curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @-
"<qualys_base_url>/qps/rest/3.0/search/am/azureassetdataconnector"
Request POST data (XML)
<?xml version="1.0" encoding="UTF-8" ?>
<root>
<ServiceRequest>
<filters>
<Criteria>
<field>id</field>
<operator>EQUALS</operator>
<value>xxxxx</value>
</Criteria>
<Criteria>
<field>name</field>
<operator>EQUALS</operator>
<value>Azure Connector Via API</value>
</Criteria>
<Criteria>
<field>description</field>
<operator>EQUALS</operator>
<value>Sample Azure Connector API</value>
</Criteria>
<Criteria>
<field>connectorState</field>
<operator>EQUALS</operator>
<value>FINISHED_SUCCESS</value>
</Criteria>
<Criteria>
<field>lastSync</field>
<operator>EQUALS</operator>
<value>2022-05-27T13:48:17Z</value>
</Criteria>
<Criteria>
<field>type</field>
<operator>EQUALS</operator>
<value>AZURE</value>
</Criteria>
<Criteria>
<field>activation</field>
<operator>EQUALS</operator>
<value>PC</value>
</Criteria>
<Criteria>
<field>authRecord.applicationId</field>
<operator>EQUALS</operator>
<value>xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7</value>
</Criteria>
<Criteria>
<field>authRecord.directoryId</field>
<operator>EQUALS</operator>
<value>xxxxxxxxx-65ab-xxxx-9e5b-1ea02d3d94eb</value>
</Criteria>
<Criteria>
<field>authRecord.subscriptionId</field>
<operator>EQUALS</operator>
<value>xxxxxxxxx-4f67-xxxx-917d-2246853844e1</value>
</Criteria>
<Criteria>
<field>appCapability.name</field>
<operator>EQUALS</operator>
<value>CSA</value>
</Criteria>
<Criteria>
<field>appCapability.tag.name</field>
<operator>EQUALS</operator>
<value>QATag</value>
</Criteria>
<Criteria>
<field>disabled</field>
<operator>EQUALS</operator>
<value>false</value>
</Criteria>
<Criteria>
<field>defaultTags.name</field>
<operator>EQUALS</operator>
<value>QATag</value>
</Criteria>
<Criteria>
<field>defaultTags</field>
<operator>EQUALS</operator>
<value>123442387</value>
</Criteria>
<Criteria>
<field>lastError</field>
<operator>EQUALS</operator>
<value>2022-04-28T19:05:04Z</value>
</Criteria>
</filters>
</ServiceRequest>
</root>
Response (XML)
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceResponse>
<responseCode>SUCCESS</responseCode>
<count>1</count>
<data>
<AzureAssetDataConnector>
<nextSync>2022-06-30T18:51:02Z</nextSync>
<connectorAppInfos>
<list>
<ConnectorAppInfoQList>
<list>
<ConnectorAppInfo>
<name>CI</name>
<identifier>xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7</identifier>
</ConnectorAppInfo>
</list>
</ConnectorAppInfoQList>
</list>
<list>
<ConnectorAppInfoQList>
<list>
<ConnectorAppInfo>
<name>CSA</name>
<identifier>xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7</identifier>
</ConnectorAppInfo>
</list>
</ConnectorAppInfoQList>
</list>
<list>
<ConnectorAppInfoQList>
<list>
<ConnectorAppInfo>
<name>AI</name>
<identifier>xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7</identifier>
</ConnectorAppInfo>
</list>
</ConnectorAppInfoQList>
</list>
</connectorAppInfos>
<disabled>false</disabled>
<id>842602</id>
<connectorState>QUEUED</connectorState>
<name>Azure Connector Via API Updated12</name>
<isRemediationEnabled>true</isRemediationEnabled>
<lastSync>2022-06-30T14:51:14Z</lastSync>
<runFrequency>240</runFrequency>
<authRecord>
<authenticationKey>02LCb8/RCn0xxxxxxx85aSmCxnoH01rog=</authenticationKey>
<applicationId>xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7</applicationId>
<directoryId>xxxxxxxxx-65ab-xxxx-9e5b-1ea02d3d94eb</directoryId>
<subscriptionId>9de9e0a7-4f67-4812-917d-2246853844e1</subscriptionId>
</authRecord>
<cloudviewUuid>xxxxxxxxx-f881-xxxx-b5d7-c5c1faddfa39</cloudviewUuid>
<isDeleted>false</isDeleted>
<isGovCloudConfigured>false</isGovCloudConfigured>
<type>AZURE</type>
<activation>
<ActivationModule>CLOUDVIEW</ActivationModule>
</activation>
<subscriptionName>cvtest</subscriptionName>
<description>Sample Azure Connector API Updated</description>
</AzureAssetDataConnector>
</data>
<hasMoreRecords>false</hasMoreRecords>
</ServiceResponse>
API Request (JSON)
"curl -u""USERNAME:PASSWORD""-X""POST""--
data-binary @-""<qualys_base_url>/qps/rest/3.0/search/am/azureassetdataconnector""--header""Accept: application/json""--header""Content-Type: application/json"
Request POST Data (JSON)
{
"ServiceRequest":{
"filters":{
"Criteria":[
{
"field":"id",
"operator":"EQUALS",
"value":"842602"
},
{
"field":"name",
"operator":"EQUALS",
"value":"Azure Connector Via API"
},
{
"field":"description",
"operator":"EQUALS",
"value":"Sample Azure Connector API"
},
{
"field":"connectorState",
"operator":"EQUALS",
"value":"FINISHED_SUCCESS"
},
{
"field":"lastSync",
"operator":"EQUALS",
"value":"2022-05-27T13:48:17Z"
},
{
"field":"type",
"operator":"EQUALS",
"value":"AZURE"
},
{
"field":"activation",
"operator":"EQUALS",
"value":"PC"
},
{
"field":"authRecord.applicationId",
"operator":"EQUALS",
"value":"xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7"
},
{
"field":"authRecord.directoryId",
"operator":"EQUALS",
"value":"xxxxxxxxx-65ab-xxxx-9e5b-1ea02d3d94eb"
},
{
"field":"authRecord.subscriptionId",
"operator":"EQUALS",
"value":"xxxxxxxxx-4f67-xxxx-917d-2246853844e1"
},
{
"field":"appCapability.name",
"operator":"EQUALS",
"value":"CSA"
},
{
"field":"appCapability.tag.name",
"operator":"EQUALS",
"value":"QATag"
},
{
"field":"disabled",
"operator":"EQUALS",
"value":"false"
},
{
"field":"defaultTags.name",
"operator":"EQUALS",
"value":"QATag"
},
{
"field":"defaultTags",
"operator":"EQUALS",
"value":"123442387"
},
{
"field":"lastError",
"operator":"EQUALS",
"value":"2022-04-28T19:05:04Z"
}
]
}
}
}
Response (JSON)
{
"ServiceResponse":{
"responseCode":"SUCCESS",
"count":1,
"data":[
{
"AzureAssetDataConnector":{
"nextSync":"2022-06-30T18:51:02Z",
"connectorAppInfos":{
"list":[
{
"ConnectorAppInfoQList":{
"list":[
{
"ConnectorAppInfo":{
"name":"CI",
"identifier":"xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7"
}
}
]
}
},
{
"ConnectorAppInfoQList":{
"list":[
{
"ConnectorAppInfo":{
"name":"CSA",
"identifier":"xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7"
}
}
]
}
},
{
"ConnectorAppInfoQList":{
"list":[
{
"ConnectorAppInfo":{
"name":"AI",
"identifier":"xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7"
}
}
]
}
}
]
},
"disabled":"false",
"id":842602,
"connectorState":"QUEUED",
"name":"Azure Connector Via API Updated12",
"isRemediationEnabled":"true",
"lastSync":"2022-06-30T14:51:14Z",
"runFrequency":240,
"authRecord":{
"authenticationKey":"02LCb8/RCn0lbGxxxxxxG2z85aSmCxnoH01rog=",
"applicationId":"xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7",
"directoryId":"xxxxxxxxx-65ab-xxxx-9e5b-1ea02d3d94eb",
"subscriptionId":"xxxxxxxxx-4f67-xxxx-917d-2246853844e1"
},
"cloudviewUuid":"xxxxxxxxx-f881-xxxx-b5d7-c5c1faddfa39",
"isDeleted":"false",
"isGovCloudConfigured":"false",
"type":"AZURE",
"activation":{
"ActivationModule":[
"CLOUDVIEW"
]
},
"subscriptionName":"cvtest",
"description":"Sample Azure Connector API Updated"
}
}
],
"hasMoreRecords":"false"
}
}