Systems - List

Service:: Sentinel

API Version:: 2025-04-01-preview

ListAll the systems.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems?api-version=2025-04-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents/{agentResourceName}/systems?api-version=2025-04-01-preview&$filter={$filter}&$skipToken={$skipToken}

URI Parameters

Name	In	Required	Type	Description
agentResourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9,-]*$	Business Application Agent Name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	The name of the workspace.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	Filters the results, based on a Boolean condition. Optional.
$skipToken	query		string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional.

Responses

Name	Type	Description
200 OK	SystemsList	Ok
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Systems_List

Sample request

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/3123432b-0b60-4af3-8720-77f01a25d34a/systems?api-version=2025-04-01-preview

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/businessApplicationAgents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/systems/3b6bed7b-3f1c-47fc-ab8e-2c57047ed446",
      "name": "3b6bed7b-3f1c-47fc-ab8e-2c57047ed446",
      "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
      "type": "Microsoft.SecurityInsights/businessApplicationAgents/systems",
      "properties": {
        "status": "Running",
        "configuration": {
          "azureResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace",
          "connector": {
            "abapServerHost": "1.1.1.1",
            "systemNumber": "001",
            "systemId": "A4H",
            "client": "001",
            "authenticationType": "UsernamePassword",
            "type": "Rfc"
          },
          "logs": [
            {
              "type": "AbapAuditLog",
              "ingestionType": "Incremental",
              "status": "Enabled",
              "scheduleInterval": 60,
              "bulkSize": 100,
              "filters": [
                "filter1",
                "filter2"
              ]
            },
            {
              "type": "USR01",
              "ingestionType": "Incremental",
              "status": "Enabled",
              "scheduleInterval": 60,
              "bulkSize": 100,
              "filters": [
                "filter1",
                "filter2"
              ]
            }
          ],
          "type": "SAP"
        },
        "displayName": "A4H_System",
        "lastModifiedTimeUtc": "2024-03-01T13:00:30Z"
      }
    }
  ]
}

Definitions

Name	Description
CloudError	Error response structure.
CloudErrorBody	Error details.
ConfigurationType	Represents the types of configuration for a system.
createdByType	The type of identity that created the resource.
HttpsConfigurationType	Represents the types of HTTPS configuration to connect to the SapControl service.
IngestionType	Types of ingestion.
Log	Describes a log.
LogStatusType	Types of log status.
LogType	Types of logs and tables.
RfcConnector	Describes the Rfc connector.
SapAuthenticationType	Types of authentication to SAP.
SapControlConnector	Describes the SapControl connector configuration.
SapSystemsConfiguration	Describes the SAP configuration.
SystemConfigurationConnectorType	Represents the types of SAP systems.
systemData	Metadata pertaining to creation and last modification of the resource.
SystemResource	Describes the system within the agent.
SystemsList	List of Agent's Systems.
SystemStatusType	The status of the system.

CloudError

Object

Error response structure.

Name	Type	Description
error	CloudErrorBody	Error data

CloudErrorBody

Object

Error details.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	string	A message describing the error, intended to be suitable for display in a user interface.

ConfigurationType

Enumeration

Represents the types of configuration for a system.

Value	Description
SAP

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

HttpsConfigurationType

Enumeration

Represents the types of HTTPS configuration to connect to the SapControl service.

Value	Description
HttpOnly
HttpsWithSslVerification
HttpsWithoutSslVerification

IngestionType

Enumeration

Types of ingestion.

Value	Description
Full
Incremental

Log

Object

Describes a log.

Name	Type	Description
bulkSize	integer (int32)	The bulk size for the log.
filters	string[]	The filters for the log.
ingestionType	IngestionType	Types of ingestion.
scheduleInterval	integer (int32)	The schedule interval in seconds.
status	LogStatusType	Types of log status.
type	LogType	Types of logs and tables.

LogStatusType

Enumeration

Types of log status.

Value	Description
Enabled
Disabled

LogType

Enumeration

Types of logs and tables.

Value	Description
AbapAuditLog
AbapJobLog
AbapSpoolLog
AbapSpoolOutputLog
AbapChangeDocsLog
AbapAppLog
AbapWorkflowLog
AbapCrLog
AbapTableDataLog
AbapFilesLogs
JavaFilesLogs
AGRTCODES
USR01
USR02
AGR1251
AGRUSERS
AGRPROF
UST04
USR21
ADR6
ADCP
USR05
USGRPUSER
USERADDR
DEVACCESS
AGRDEFINE
PAHI
AGRAGRS
USRSTAMP
AGRFLAGS
SNCSYSACL
USRACL

RfcConnector

Object

Describes the Rfc connector.

Name	Type	Description
abapServerHost	string	FQDN, hostname, or IP address of the ABAP server.
authenticationType	SapAuthenticationType	The authentication type to SAP.
client	string minLength: 1 pattern: ^[0-9]{3}$	Client number of the ABAP server. Example - 001
codePage	string pattern: ^(?:[a-zA-Z0-9]{4}\|UTF-8)$	The SAP code page used for character encoding. Example - 1100
group	string	Logon group of the message server.
messageServerHost	string	FQDN, hostname, or IP address of the Message server.
messageServerService	string	Port number, or service name (from /etc/services) of the message server.
sncQop	string pattern: ^[1,2,3,8,9]$	SNC QOP. Options are 1, 2, 3, 8, 9.
systemId	string minLength: 1 pattern: ^[a-zA-Z0-9]{3}$	System ID of the ABAP server. Example - A4H
systemNumber	string minLength: 1 pattern: ^\d{1,3}$	System number of the ABAP server.
type	SystemConfigurationConnectorType	Represents the types of SAP systems.

SapAuthenticationType

Enumeration

Types of authentication to SAP.

Value	Description
UsernamePassword
Snc
SncWithUsernamePassword

SapControlConnector

Object

Describes the SapControl connector configuration.

Name	Type	Default value	Description
httpsConfiguration	HttpsConfigurationType		Represents the types of HTTPS configuration to connect to the SapControl service.
instance	string minLength: 1 pattern: ^\d{2}$		The instance number. Only 2 digits are allowed.
port	string pattern: ^\d{1,5}$		The port of the SOAP connection to SAP Control.
server	string minLength: 1 pattern: ^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-zA-Z]{2,}$\|^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$		The server name. FQDN or IP address.
timezone	string pattern: ^GMT[+-]\d+$	GMT+0	The timezone. example: "GMT+0" or "GMT-8" default: "GMT+0"
type	SystemConfigurationConnectorType		Represents the types of SAP systems.

SapSystemsConfiguration

Object

Describes the SAP configuration.

Name	Type	Description
azureResourceId	string pattern: ^\/?subscriptions\/([^\/]+)\/resourceGroups\/([^\/]+)\/providers\/([^\/]+)\/([^\/]+)\/([^\/]+)$	azure resource id example: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
connector	SystemsConfigurationConnector: RfcConnector SapControlConnector	Base Model for SAP System Connector.
logs	Log[]	The logs configuration.
type	ConfigurationType	Represents the types of configuration for a system.

SystemConfigurationConnectorType

Enumeration

Represents the types of SAP systems.

Value	Description
Rfc
SapControl

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

SystemResource

Object

Describes the system within the agent.

Name	Type	Description
etag	string	Etag of the azure resource
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.configuration	SystemsConfiguration: SapSystemsConfiguration	The configuration of the system.
properties.displayName	string minLength: 1
properties.lastModifiedTimeUtc	string (date-time)
properties.status	SystemStatusType	The status of the system.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SystemsList

Object

List of Agent's Systems.

Name	Type	Description
nextLink	string
value	SystemResource[]	Describes the system within the agent.

SystemStatusType

Enumeration

The status of the system.

Value	Description
Running
Stopped

Share via

Systems - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Systems_List

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

ConfigurationType

createdByType

HttpsConfigurationType

IngestionType

Log

LogStatusType

LogType

RfcConnector

SapAuthenticationType

SapControlConnector

SapSystemsConfiguration

SystemConfigurationConnectorType

systemData

SystemResource

SystemsList

SystemStatusType