Describe an existing Azure Connector
Describe an Azure Connector by ID.
AzureConnectorsApi.describeAzureConnector([param1, param2, ...])
AzureConnectorsApi.describe_azure_connector([param1, param2, ...])
AzureConnectorsApi.describeAzureConnector([param1, param2, ...])
successful operation
Not authorized to view Azure Connectors.
The Azure Connector does not exist.
- 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(); } } }
- 200
{- "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
Modify the specified Azure Connector by ID. Any unset elements will be left unchanged. Property azureTenantID
, subscriptionID
, loginApiEndPoint
and resourceApiEndPoint
can't be modified.
AzureConnectorsApi.modifyAzureConnector([param1, param2, ...])
AzureConnectorsApi.modify_azure_connector([param1, param2, ...])
AzureConnectorsApi.modifyAzureConnector([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the Azure Connector to modify.
successful operation
Microsoft Entra ID (formerly Azure AD) application not associated with subscription
Not authorized to modify Azure Connectors or the requested modification is not permitted.
The Azure account does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "azureTenantID": "string",
- "subscriptionID": "string",
- "azureAdApplicationID": "string",
- "azureAdApplicationSecret": "string",
- "azureAdApplicationCertificate": "string",
- "azureAdApplicationPrivateKey": "string",
- "azureAdApplicationPrivateKeySecret": "string",
- "resourceApiEndPoint": "string",
- "loginApiEndPoint": "string",
- "parentGroupID": 0
}
- 200
{- "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 an existing Azure Connector by ID.
AzureConnectorsApi.deleteAzureConnector([param1, param2, ...])
AzureConnectorsApi.delete_azure_connector([param1, param2, ...])
AzureConnectorsApi.deleteAzureConnector([param1, param2, ...])
Request is successful.
Not authorized to delete Azure Connectors.
The Azure account does not exist.
- 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
Search for Azure Connectors using optional filters.
AzureConnectorsApi.searchAzureConnectors([param1, param2, ...])
AzureConnectorsApi.search_azure_connectors([param1, param2, ...])
AzureConnectorsApi.searchAzureConnectors([param1, param2, ...])
header Parameters
Request Body schema: application/json
A collection of options used to filter the search results.
successful operation
Not authorized to view Azure Connectors.
- Payload
- Java
- Python
- JavaScript
{- "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
}
- 200
{- "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
Lists all Azure Connectors.
AzureConnectorsApi.listAzureConnectors([param1, param2, ...])
AzureConnectorsApi.list_azure_connectors([param1, param2, ...])
AzureConnectorsApi.listAzureConnectors([param1, param2, ...])
successful operation
Not authorized to view Azure Connectors.
- 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(); } } }
- 200
{- "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
Create a new Azure Connector.
AzureConnectorsApi.createAzureConnector([param1, param2, ...])
AzureConnectorsApi.create_azure_connector([param1, param2, ...])
AzureConnectorsApi.createAzureConnector([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the new Azure Connector.
successful operation
Microsoft Entra ID (formerly Azure AD) application not associated with subscription.
Not authorized to create Azure Connectors.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "azureTenantID": "string",
- "subscriptionID": "string",
- "azureAdApplicationID": "string",
- "azureAdApplicationSecret": "string",
- "azureAdApplicationCertificate": "string",
- "azureAdApplicationPrivateKey": "string",
- "azureAdApplicationPrivateKeySecret": "string",
- "resourceApiEndPoint": "string",
- "loginApiEndPoint": "string",
- "parentGroupID": 0
}
- 200
{- "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
Move the specified Azure connector by ID to target computer group.
AzureConnectorsApi.moveAzureConnector([param1, param2, ...])
AzureConnectorsApi.move_azure_connector([param1, param2, ...])
AzureConnectorsApi.moveAzureConnector([param1, param2, ...])
path Parameters
query Parameters
successful operation
Bad request to move Azure Connectors.
Not authorized to modify Azure Connectors or the requested modification is not permitted.
The Azure account does not exist.
- 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(); } } }
- 200
{- "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
}