keyboard_arrow_down
  • 12.0
  • 20.0

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, ...])

Request
Security:
DefaultAuthentication
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
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
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 DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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,
  • "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, ...])

Request
Security:
DefaultAuthentication
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 Microsoft Entra ID (formerly 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 Microsoft Entra ID (formerly Azure Active Directory) Application ID. Searchable as String.

azureAdApplicationPrivateKey
string

The Microsoft Entra ID (formerly 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 Microsoft Entra ID (formerly Azure Active Directory) Application private key if the private key is protected with secret/password.

azureAdApplicationSecret
string

The Microsoft Entra ID (formerly Azure Active Directory) Application secret/password. Not present in returned objects.

azureTenantID
string

The Microsoft Entra tenant ID (formly Azure Tenant/Active Directory ID). Searchable as String.

loginApiEndPoint
string

The optional Microsoft Entra ID (formerly 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.

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
application/json
{
  • "name": "string",
  • "azureTenantID": "string",
  • "subscriptionID": "string",
  • "azureAdApplicationID": "string",
  • "azureAdApplicationSecret": "string",
  • "azureAdApplicationCertificate": "string",
  • "azureAdApplicationPrivateKey": "string",
  • "azureAdApplicationPrivateKeySecret": "string",
  • "resourceApiEndPoint": "string",
  • "loginApiEndPoint": "string"
}
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,
  • "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, ...])

Request
Security:
DefaultAuthentication
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
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
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 DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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();
		}
	}
}

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, ...])

Request
Security:
DefaultAuthentication
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
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
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 DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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": [
    ]
}

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, ...])

Request
Security:
DefaultAuthentication
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 Microsoft Entra ID (formerly 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 Microsoft Entra ID (formerly Azure Active Directory) Application ID. Searchable as String.

azureAdApplicationPrivateKey
string

The Microsoft Entra ID (formerly 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 Microsoft Entra ID (formerly Azure Active Directory) Application private key if the private key is protected with secret/password.

azureAdApplicationSecret
string

The Microsoft Entra ID (formerly Azure Active Directory) Application secret/password. Not present in returned objects.

azureTenantID
string

The Microsoft Entra tenant ID (formly Azure Tenant/Active Directory ID). Searchable as String.

loginApiEndPoint
string

The optional Microsoft Entra ID (formerly 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.

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
application/json
{
  • "name": "string",
  • "azureTenantID": "string",
  • "subscriptionID": "string",
  • "azureAdApplicationID": "string",
  • "azureAdApplicationSecret": "string",
  • "azureAdApplicationCertificate": "string",
  • "azureAdApplicationPrivateKey": "string",
  • "azureAdApplicationPrivateKeySecret": "string",
  • "resourceApiEndPoint": "string",
  • "loginApiEndPoint": "string"
}
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,
  • "ID": 0
}

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, ...])

Request
Security:
DefaultAuthentication
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
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "azureConnectors": [
    ]
}
➔ Next to Computers