Search Azure Connectors

[POST] /qps/rest/2.0/search/am/azureassetdataconnector

Returns a list of Azure connectors that match the provided criteria.

Limit your results - Use the optional “fields” parameter to limit the amount of information returned for each AWS connector.

Pagination - A maximum of 100 instances are returned by default. To customize this specify a “preferences” tag in the POST body of your request.



Permissions required - Managers with full scope.

Input ParameterInput Parameter

Click here for available operators

Parameter

Mandatory

/Optional

Data Type

Description

id 

Optional

integer

The ID of the connector that you want to search.

name

Optional

text

Name is the name for the connector you want to search.

description 

Optional

text

Description of the connector you want to search.

lastSync 

Optional

date

Last sync date of the connector

type

Optional

AssetDataConnectorType

Azure, not writeable

applicationId 

Optional

integer

Unique identifier of the application you create on Azure portal.

directoryId 

Optional

integer

Unique identifier of your Azure Active Directory.

activation

Optional

Keyword

 VM, PC, SCA, CERTVIEW

subscriptionId 

Optional

integer

Unique identifier of your Microsoft Azure subscription.

Sample 1 - Search Azure Connector using connector nameSample 1 - Search Azure Connector using connector name

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/2.0/search/am/azureassetdataconnector" 
<file.xml
Note: file.xml contains request POST data      
    

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="name" operator="EQUALS">My Azure connector</Criteria>
    </filters>
</ServiceRequest>      
    

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/2.0/am/azure_asset_data_connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <hasMoreRecords>false</hasMoreRecords>
    <data>
        <AzureAssetDataConnector>
            <id>287603</id>
            <name>My Azure connector</name>
            <description>Sample Connector</description>
            <lastSync>2019-05-27T06:26:29Z</lastSync>
            <connectorState>QUEUED</connectorState>
            <type>AZURE</type>
            <defaultTags>
                <list>
                    <TagSimple>
                        <id>8523019</id>
                        <name>azure static tag</name>
                    </TagSimple>
                </list>
            </defaultTags>
            <disabled>false</disabled>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <authRecord/>
        </AzureAssetDataConnector>
    </data>
</ServiceResponse>      
    

Sample 2 - Search Azure Connector by subscription IDSample 2 - Search Azure Connector by subscription ID

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/2.0/search/am/azureassetdataconnector" <file.xml

Note: file.xml contains request POST data

 

Request POST data

<ServiceRequest>

    <filters>

        <Criteria field="authRecord.subscriptionId" operator="EQUALS">11111111-1111-1111-1111-111111111111</Criteria>

    </filters>

</ServiceRequest>

Response

<ServiceRequest>
    <filters>
        <Criteria field="authRecord.subscriptionId" operator="EQUALS">11111111-1111-1111-1111-111111111111</Criteria>
    </filters>
</ServiceRequest>      
    

XSD

<platform API server>/qps/xsd/2.0/am/azure_asset_data_connector.xsd