Business Application Agents - List

Service:: Sentinel

API Version:: 2025-04-01-preview

Gets all Business Application Agents under the workspace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/businessApplicationAgents?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?api-version=2025-04-01-preview&$filter={$filter}&$skipToken={$skipToken}

URI Parameters

Name	In	Required	Type	Description
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	BusinessApplicationAgentsList	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

BusinessApplicationAgents_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?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",
      "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
      "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
      "type": "Microsoft.SecurityInsights/businessApplicationAgents",
      "properties": {
        "configuration": {
          "agentContainerName": "MyAgentContainer",
          "sdkPath": "/path/to/nwrfc750P_8-70002755.zip",
          "sncPath": "/path/to/snc",
          "keyVaultResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault",
          "keyVaultAuthenticationMode": "ManagedIdentity",
          "secretSource": "AzureKeyVault",
          "type": "SAP"
        },
        "agentSystems": [
          {
            "systemResourceName": "3b6bed7b-3f1c-47fc-ab8e-2c57047ed446",
            "systemDisplayName": "MySystem"
          }
        ],
        "displayName": "MyAgent",
        "lastModifiedTimeUtc": "2024-03-01T13:00:30Z"
      }
    }
  ]
}

Definitions

Name	Description
AgentSystem	Describes the configuration of a system inside the agent.
AgentType	Type of the agent
BusinessApplicationAgentResource	Describes the configuration of a Business Application Agent.
BusinessApplicationAgentsList	List of agents.
CloudError	Error response structure.
CloudErrorBody	Error details.
createdByType	The type of identity that created the resource.
KeyVaultAuthenticationMode	Type for authentication identity to key vault
SapAgentConfiguration	Describes the configuration of a SAP Docker agent.
SecretSource	Type for Secret Source - Azure Key Vault
systemData	Metadata pertaining to creation and last modification of the resource.

AgentSystem

Object

Describes the configuration of a system inside the agent.

Name	Type	Description
systemDisplayName	string
systemResourceName	string

AgentType

Enumeration

Type of the agent

Value	Description
SAP

BusinessApplicationAgentResource

Object

Describes the configuration of a Business Application 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.agentSystems	AgentSystem[]	Describes the configuration of a system inside the agent.
properties.configuration	AgentConfiguration: SapAgentConfiguration	Describes the configuration of a Business Application Agent.
properties.displayName	string minLength: 1
properties.lastModifiedTimeUtc	string (date-time)
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"

BusinessApplicationAgentsList

Object

List of agents.

Name	Type	Description
nextLink	string
value	BusinessApplicationAgentResource[]	Describes the configuration of a Business Application Agent.

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.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

KeyVaultAuthenticationMode

Enumeration

Type for authentication identity to key vault

Value	Description
ManagedIdentity
ServicePrincipal

SapAgentConfiguration

Object

Describes the configuration of a SAP Docker agent.

Name	Type	Description
agentContainerName	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	The name of the docker agent. only letters with numbers, underscores and hyphens are allowed example: "my-agent"
keyVaultAuthenticationMode	KeyVaultAuthenticationMode	The key mode of the agent. ManagedIdentity\|ApplicationIdentity are the options
keyVaultResourceId	string pattern: ^\/?subscriptions\/([^\/]+)\/resourceGroups\/([^\/]+)\/providers\/Microsoft\.KeyVault\/vaults\/([^\/]+)$	The key vault resource id to access the key vault. example: "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.KeyVault/vaults/myVault"
sdkPath	string pattern: ^/(([^/]+/)nwrfc75.\.zip$)\|^((?:[a-zA-Z]:)?(?:\\\|\\\\)(?:[^\\/:?"<>\|\r\n]+\\)nwrfc75.*\.zip)$	The SDK path (a file not a folder) on the agent machine. example: "/path/to/nwrfc750P_8-70002755.zip"
secretSource	SecretSource	The secret source of the agent. AzureKeyVault is the option
sncPath	string pattern: ^\/(?:[^/]+\/)[^/]+$\|^(?:[a-zA-Z]:)?(?:\\\|\\\\)(?:[^\\/:?"<>\|\r\n]+\\)[^\\/:?"<>\|\r\n]*$	The SNC path (a folder not a file) on the agent machine. example: "/path/to/snc"
type	AgentType	Type of the agent

SecretSource

Enumeration

Type for Secret Source - Azure Key Vault

Value	Description
AzureKeyVault

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.

Share via

Business Application Agents - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

BusinessApplicationAgents_List

Sample request

Sample response

Definitions

AgentSystem

AgentType

BusinessApplicationAgentResource

BusinessApplicationAgentsList

CloudError

CloudErrorBody

createdByType

KeyVaultAuthenticationMode

SapAgentConfiguration

SecretSource

systemData