Business Application Agents - Create Or Update

Service:: Sentinel

API-versie:: 2025-04-01-preview

Hiermee maakt of werkt u de bedrijfstoepassingsagent bij.

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

URI-parameters

Name	In	Vereist	Type	Description
agentResourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9,-]*$	Naam van bedrijfstoepassingsagent
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	De naam van de werkruimte.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
properties.configuration	True	AgentConfiguration: SapAgentConfiguration	Beschrijft de configuratie van een bedrijfstoepassingsagent.
properties.displayName	True	string minLength: 1
etag		string	Etag van de Azure-resource

Antwoorden

Name	Type	Description
200 OK	BusinessApplicationAgentResource	OK
201 Created	BusinessApplicationAgentResource	Gecreëerd
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

BusinessApplicationAgents_CreateOrUpdate

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "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"
    },
    "displayName": "MyAgent",
    "lastModifiedTimeUtc": "2024-03-01T13:00:30Z"
  }
}

Statuscode:: 201

{
  "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"
    },
    "displayName": "MyAgent",
    "lastModifiedTimeUtc": "2024-03-01T13:00:30Z"
  }
}

Definities

Name	Description
AgentSystem	Beschrijft de configuratie van een systeem in de agent.
AgentType	Type agent
BusinessApplicationAgentResource	Beschrijft de configuratie van een bedrijfstoepassingsagent.
CloudError	Structuur van foutreacties.
CloudErrorBody	Foutdetails.
createdByType	Het type identiteit waarmee de resource is gemaakt.
KeyVaultAuthenticationMode	Type voor verificatie-identiteit naar sleutelkluis
SapAgentConfiguration	Beschrijft de configuratie van een SAP Docker-agent.
SecretSource	Type voor geheime bron - Azure Key Vault
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

AgentSystem

Object

Beschrijft de configuratie van een systeem in de agent.

Name	Type	Description
systemDisplayName	string
systemResourceName	string

AgentType

Inventarisatie

Type agent

Waarde	Description
SAP

BusinessApplicationAgentResource

Object

Beschrijft de configuratie van een bedrijfstoepassingsagent.

Name	Type	Description
etag	string	Etag van de Azure-resource
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.agentSystems	AgentSystem[]	Beschrijft de configuratie van een systeem in de agent.
properties.configuration	AgentConfiguration: SapAgentConfiguration	Beschrijft de configuratie van een bedrijfstoepassingsagent.
properties.displayName	string minLength: 1
properties.lastModifiedTimeUtc	string (date-time)
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

CloudError

Object

Structuur van foutreacties.

Name	Type	Description
error	CloudErrorBody	Foutgegevens

CloudErrorBody

Object

Foutdetails.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

KeyVaultAuthenticationMode

Inventarisatie

Type voor verificatie-identiteit naar sleutelkluis

Waarde	Description
ManagedIdentity
ServicePrincipal

SapAgentConfiguration

Object

Beschrijft de configuratie van een SAP Docker-agent.

Name	Type	Description
agentContainerName	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	De naam van de Docker-agent. alleen letters met cijfers, onderstrepingstekens en afbreekstreepjes zijn toegestaan: 'my-agent'
keyVaultAuthenticationMode	KeyVaultAuthenticationMode	De sleutelmodus van de agent. ManagedIdentity \|ApplicationIdentity zijn de opties
keyVaultResourceId	string pattern: ^\/?subscriptions\/([^\/]+)\/resourceGroups\/([^\/]+)\/providers\/Microsoft\.KeyVault\/vaults\/([^\/]+)$	De resource-id van de sleutelkluis voor toegang tot de sleutelkluis. voorbeeld: "/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)$	Het SDK-pad (een bestand niet een map) op de agentcomputer. voorbeeld: "/path/to/nwrfc750P_8-70002755.zip"
secretSource	SecretSource	De geheime bron van de agent. AzureKeyVault is de optie
sncPath	string pattern: ^\/(?:[^/]+\/)[^/]+$\|^(?:[a-zA-Z]:)?(?:\\\|\\\\)(?:[^\\/:?"<>\|\r\n]+\\)[^\\/:?"<>\|\r\n]*$	Het SNC-pad (een map niet een bestand) op de agentcomputer. voorbeeld: "/path/to/snc"
type	AgentType	Type agent

SecretSource

Inventarisatie

Type voor geheime bron - Azure Key Vault

Waarde	Description
AzureKeyVault

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Business Application Agents - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

BusinessApplicationAgents_CreateOrUpdate

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AgentSystem

AgentType

BusinessApplicationAgentResource

CloudError

CloudErrorBody

createdByType

KeyVaultAuthenticationMode

SapAgentConfiguration

SecretSource

systemData