Azure Connectors

Describe an existing Azure Connector

get/azureconnectors/{azureConnectorID}

Describe an Azure Connector by ID.

Related SDK Methods:

Java

AzureConnectorsApi.describeAzureConnector([param1, param2, ...])

Python

AzureConnectorsApi.describe_azure_connector([param1, param2, ...])

JavaScript

AzureConnectorsApi.describeAzureConnector([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

path Parameters

azureConnectorID

required

integer <int32> \d+

The ID number of the Azure Connector to describe.

Example: 1

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Responses

200

successful operation

403

Not authorized to view Azure Connectors.

404

The Azure Connector does not exist.

Request samples

Java
Python
JavaScript

import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.AzureConnectorsApi;
import com.trendmicro.deepsecurity.model.AzureConnector;


public class DescribeAzureConnectorExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		AzureConnectorsApi instance = new AzureConnectorsApi();
		Integer azureConnectorID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			AzureConnector result = instance.describeAzureConnector(azureConnectorID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AzureConnectorsApi.describeAzureConnector");
			e.printStackTrace();
		}
	}
}

Response samples

application/json

{"name": "string",
"azureTenantID": "string",
"subscriptionID": "string",
"azureAdApplicationID": "string",
"azureAdApplicationSecret": "string",
"azureAdApplicationCertificate": "string",
"azureAdApplicationPrivateKey": "string",
"azureAdApplicationPrivateKeySecret": "string",
"azureAdApplicationCertificateExpirationDate": 0,
"resourceApiEndPoint": "string",
"loginApiEndPoint": "string",
"lastSyncTime": 0,
"parentGroupID": 0,
"ID": 0
}

Modify an Azure Connector

post/azureconnectors/{azureConnectorID}

Modify the specified Azure Connector by ID. Any unset elements will be left unchanged. Property azureTenantID, subscriptionID, loginApiEndPoint and resourceApiEndPoint can't be modified.

Related SDK Methods:

Java

AzureConnectorsApi.modifyAzureConnector([param1, param2, ...])

Python

AzureConnectorsApi.modify_azure_connector([param1, param2, ...])

JavaScript

AzureConnectorsApi.modifyAzureConnector([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

path Parameters

azureConnectorID

required

integer <int32> \d+

The ID number of the Azure Connector to modify.

Example: 1

query Parameters

sync	boolean Immediately trigger a synchronization for the Azure Connector.

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

The settings of the Azure Connector to modify.

azureAdApplicationCertificate	string The Azure Active Directory Application certificate for authentication. The certificate should be in X.509 PEM format and encoded in Base64. Not present in returned objects.
azureAdApplicationID	string The Azure Active Directory Application ID. Searchable as String.
azureAdApplicationPrivateKey	string The Azure Active Directory Application private key of azureAdApplicationCertificate. The private key should be in PEM format and encoded in Base64. Not present in returned objects.
azureAdApplicationPrivateKeySecret	string The optional secret of Azure Active Directory Application private key if the private key is protected with secret/password.
azureAdApplicationSecret	string The Azure Active Directory Application secret/password. Not present in returned objects.
azureTenantID	string The Azure Tenant/Active Directory ID. Searchable as String.
loginApiEndPoint	string The optional Azure Active Directory Login/Authentication API endpoint. Will auto detect by DSM VM location if not provided. This is an advanced option used if you want to access private or confidential cloud. Be aware that managing Azure Government computers outside Azure Government would break ITAR compliance.
name	string The Azure Connector's display name in DSM. Searchable as String.
parentGroupID	integer <int32> ID of the ComputerGroup's parent group. Empty if the parent is a root ComputerGroup. ComputerGroup will be a root group unless a valid value for `parentGroupID` is set. Searchable as Numeric.
resourceApiEndPoint	string The optional Azure Resource REST API endpoint. Will auto detect by DSM VM location if not provided. This is an advanced option used if you want to access private or confidential cloud. Be aware that managing Azure Government computers outside Azure Government would break ITAR compliance.
subscriptionID	string The Azure Subscription ID. Searchable as String.

Responses

200

successful operation

400

Microsoft Entra ID (formerly Azure AD) application not associated with subscription

403

Not authorized to modify Azure Connectors or the requested modification is not permitted.

404

The Azure account does not exist.

Request samples

Payload
Java
Python
JavaScript

application/json

{"name": "string",
"azureTenantID": "string",
"subscriptionID": "string",
"azureAdApplicationID": "string",
"azureAdApplicationSecret": "string",
"azureAdApplicationCertificate": "string",
"azureAdApplicationPrivateKey": "string",
"azureAdApplicationPrivateKeySecret": "string",
"resourceApiEndPoint": "string",
"loginApiEndPoint": "string",
"parentGroupID": 0
}

Response samples

application/json

{"name": "string",
"azureTenantID": "string",
"subscriptionID": "string",
"azureAdApplicationID": "string",
"azureAdApplicationSecret": "string",
"azureAdApplicationCertificate": "string",
"azureAdApplicationPrivateKey": "string",
"azureAdApplicationPrivateKeySecret": "string",
"azureAdApplicationCertificateExpirationDate": 0,
"resourceApiEndPoint": "string",
"loginApiEndPoint": "string",
"lastSyncTime": 0,
"parentGroupID": 0,
"ID": 0
}

Delete an Azure Connector

delete/azureconnectors/{azureConnectorID}

Delete an existing Azure Connector by ID.

Related SDK Methods:

Java

AzureConnectorsApi.deleteAzureConnector([param1, param2, ...])

Python

AzureConnectorsApi.delete_azure_connector([param1, param2, ...])

JavaScript

AzureConnectorsApi.deleteAzureConnector([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

path Parameters

azureConnectorID

required

integer <int32> \d+

The ID number of the Azure Connector to delete.

Example: 1

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Responses

200

Request is successful.

403

Not authorized to delete Azure Connectors.

404

The Azure account does not exist.

Request samples

Java
Python
JavaScript

import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.AzureConnectorsApi;


public class DeleteAzureConnectorExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		AzureConnectorsApi instance = new AzureConnectorsApi();
		Integer azureConnectorID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteAzureConnector(azureConnectorID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AzureConnectorsApi.deleteAzureConnector");
			e.printStackTrace();
		}
	}
}

Search Azure Connectors

post/azureconnectors/search

Search for Azure Connectors using optional filters.

Related SDK Methods:

Java

AzureConnectorsApi.searchAzureConnectors([param1, param2, ...])

Python

AzureConnectorsApi.search_azure_connectors([param1, param2, ...])

JavaScript

AzureConnectorsApi.searchAzureConnectors([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

A collection of options used to filter the search results.

maxItems	integer <int32> Limits the number of objects returned. Default 5000.
	Array of objects (searchCriteria) Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.
sortByObjectID	boolean If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses

200

successful operation

403

Not authorized to view Azure Connectors.

Request samples

Payload
Java
Python
JavaScript

application/json

{"maxItems": 0,
"searchCriteria": [{"fieldName": "string",
"booleanTest": true,
"numericTest": "less-than",
"numericValue": 0,
"numericValueList": [0
],
"stringTest": "equal",
"stringValue": "string",
"stringWildcards": true,
"choiceTest": "equal",
"choiceValue": "string",
"firstDateValue": 0,
"firstDateInclusive": true,
"lastDateValue": 0,
"lastDateInclusive": true,
"nullTest": true,
"versionTest": "less-than",
"versionValue": "string",
"idValue": 0,
"idTest": "less-than",
"idValueList": [0
]
}
],
"sortByObjectID": true
}

Response samples

application/json

{"azureConnectors": [{"name": "string",
"azureTenantID": "string",
"subscriptionID": "string",
"azureAdApplicationID": "string",
"azureAdApplicationSecret": "string",
"azureAdApplicationCertificate": "string",
"azureAdApplicationPrivateKey": "string",
"azureAdApplicationPrivateKeySecret": "string",
"azureAdApplicationCertificateExpirationDate": 0,
"resourceApiEndPoint": "string",
"loginApiEndPoint": "string",
"lastSyncTime": 0,
"parentGroupID": 0,
"ID": 0
}
]
}

List Azure Connectors

get/azureconnectors

Lists all Azure Connectors.

Related SDK Methods:

Java

AzureConnectorsApi.listAzureConnectors([param1, param2, ...])

Python

AzureConnectorsApi.list_azure_connectors([param1, param2, ...])

JavaScript

AzureConnectorsApi.listAzureConnectors([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Responses

200

successful operation

403

Not authorized to view Azure Connectors.

Request samples

Java
Python
JavaScript

import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.AzureConnectorsApi;
import com.trendmicro.deepsecurity.model.AzureConnectors;


public class ListAzureConnectorsExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		AzureConnectorsApi instance = new AzureConnectorsApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			AzureConnectors result = instance.listAzureConnectors(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AzureConnectorsApi.listAzureConnectors");
			e.printStackTrace();
		}
	}
}

Response samples

application/json

{"azureConnectors": [{"name": "string",
"azureTenantID": "string",
"subscriptionID": "string",
"azureAdApplicationID": "string",
"azureAdApplicationSecret": "string",
"azureAdApplicationCertificate": "string",
"azureAdApplicationPrivateKey": "string",
"azureAdApplicationPrivateKeySecret": "string",
"azureAdApplicationCertificateExpirationDate": 0,
"resourceApiEndPoint": "string",
"loginApiEndPoint": "string",
"lastSyncTime": 0,
"parentGroupID": 0,
"ID": 0
}
]
}

Create an Azure Connector

post/azureconnectors

Create a new Azure Connector.

Related SDK Methods:

Java

AzureConnectorsApi.createAzureConnector([param1, param2, ...])

Python

AzureConnectorsApi.create_azure_connector([param1, param2, ...])

JavaScript

AzureConnectorsApi.createAzureConnector([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

The settings of the new Azure Connector.

azureAdApplicationCertificate	string The Azure Active Directory Application certificate for authentication. The certificate should be in X.509 PEM format and encoded in Base64. Not present in returned objects.
azureAdApplicationID	string The Azure Active Directory Application ID. Searchable as String.
azureAdApplicationPrivateKey	string The Azure Active Directory Application private key of azureAdApplicationCertificate. The private key should be in PEM format and encoded in Base64. Not present in returned objects.
azureAdApplicationPrivateKeySecret	string The optional secret of Azure Active Directory Application private key if the private key is protected with secret/password.
azureAdApplicationSecret	string The Azure Active Directory Application secret/password. Not present in returned objects.
azureTenantID	string The Azure Tenant/Active Directory ID. Searchable as String.
loginApiEndPoint	string The optional Azure Active Directory Login/Authentication API endpoint. Will auto detect by DSM VM location if not provided. This is an advanced option used if you want to access private or confidential cloud. Be aware that managing Azure Government computers outside Azure Government would break ITAR compliance.
name	string The Azure Connector's display name in DSM. Searchable as String.
parentGroupID	integer <int32> ID of the ComputerGroup's parent group. Empty if the parent is a root ComputerGroup. ComputerGroup will be a root group unless a valid value for `parentGroupID` is set. Searchable as Numeric.
resourceApiEndPoint	string The optional Azure Resource REST API endpoint. Will auto detect by DSM VM location if not provided. This is an advanced option used if you want to access private or confidential cloud. Be aware that managing Azure Government computers outside Azure Government would break ITAR compliance.
subscriptionID	string The Azure Subscription ID. Searchable as String.

Responses

200

successful operation

400

Microsoft Entra ID (formerly Azure AD) application not associated with subscription.

403

Not authorized to create Azure Connectors.

Request samples

Payload
Java
Python
JavaScript

application/json

{"name": "string",
"azureTenantID": "string",
"subscriptionID": "string",
"azureAdApplicationID": "string",
"azureAdApplicationSecret": "string",
"azureAdApplicationCertificate": "string",
"azureAdApplicationPrivateKey": "string",
"azureAdApplicationPrivateKeySecret": "string",
"resourceApiEndPoint": "string",
"loginApiEndPoint": "string",
"parentGroupID": 0
}

Response samples

application/json

{"name": "string",
"azureTenantID": "string",
"subscriptionID": "string",
"azureAdApplicationID": "string",
"azureAdApplicationSecret": "string",
"azureAdApplicationCertificate": "string",
"azureAdApplicationPrivateKey": "string",
"azureAdApplicationPrivateKeySecret": "string",
"azureAdApplicationCertificateExpirationDate": 0,
"resourceApiEndPoint": "string",
"loginApiEndPoint": "string",
"lastSyncTime": 0,
"parentGroupID": 0,
"ID": 0
}

Move an Azure Connector

post/azureconnectors/{azureConnectorID}/move

Move the specified Azure connector by ID to target computer group.

Related SDK Methods:

Java

AzureConnectorsApi.moveAzureConnector([param1, param2, ...])

Python

AzureConnectorsApi.move_azure_connector([param1, param2, ...])

JavaScript

AzureConnectorsApi.moveAzureConnector([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key

Request

path Parameters

azureConnectorID

required

integer <int32> \d+

The ID number of the Azure Connector to modify.

Example: 1

query Parameters

moveToHostGroupID

integer <int32>

The ID number of target computer group. If value is 0, the Azure connector will be moved to the root

Example: moveToHostGroupID=1

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Responses

200

successful operation

400

Bad request to move Azure Connectors.

403

Not authorized to modify Azure Connectors or the requested modification is not permitted.

404

The Azure account does not exist.

Request samples

Java
Python
JavaScript

import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.AzureConnectorsApi;
import com.trendmicro.deepsecurity.model.AzureConnector;


public class MoveAzureConnectorExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		AzureConnectorsApi instance = new AzureConnectorsApi();
		Integer azureConnectorID = 1;
		Integer moveToHostGroupID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			AzureConnector result = instance.moveAzureConnector(azureConnectorID, moveToHostGroupID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling AzureConnectorsApi.moveAzureConnector");
			e.printStackTrace();
		}
	}
}

Response samples

application/json

{"name": "string",
"azureTenantID": "string",
"subscriptionID": "string",
"azureAdApplicationID": "string",
"azureAdApplicationSecret": "string",
"azureAdApplicationCertificate": "string",
"azureAdApplicationPrivateKey": "string",
"azureAdApplicationPrivateKeySecret": "string",
"azureAdApplicationCertificateExpirationDate": 0,
"resourceApiEndPoint": "string",
"loginApiEndPoint": "string",
"lastSyncTime": 0,
"parentGroupID": 0,
"ID": 0
}

➔ Next to Computers