Business Application Agents - Create Or Update

Serviço:: Sentinel

Versão da API:: 2025-04-01-preview

Cria ou atualiza o Business Application Agent.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
agentResourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9,-]*$	Nome do Agente de Aplicativo De Negócios
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	O nome do espaço de trabalho.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.configuration	True	AgentConfiguration: SapAgentConfiguration	Descreve a configuração de um Agente de Aplicativo De Negócios.
properties.displayName	True	string minLength: 1
etag		string	Etag do recurso do azure

Respostas

Nome	Tipo	Description
200 OK	BusinessApplicationAgentResource	Okey
201 Created	BusinessApplicationAgentResource	Criado
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

BusinessApplicationAgents_CreateOrUpdate

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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"
  }
}

Definições

Nome	Description
AgentSystem	Descreve a configuração de um sistema dentro do agente.
AgentType	Tipo do agente
BusinessApplicationAgentResource	Descreve a configuração de um Agente de Aplicativo De Negócios.
CloudError	Estrutura de resposta de erro.
CloudErrorBody	Detalhes do erro.
createdByType	O tipo de identidade que criou o recurso.
KeyVaultAuthenticationMode	Tipo de identidade de autenticação para o cofre de chaves
SapAgentConfiguration	Descreve a configuração de um agente do Docker SAP.
SecretSource	Tipo de fonte secreta – Azure Key Vault
systemData	Metadados relativos à criação e última modificação do recurso.

AgentSystem

Objeto

Descreve a configuração de um sistema dentro do agente.

Nome	Tipo	Description
systemDisplayName	string
systemResourceName	string

AgentType

Enumeração

Tipo do agente

Valor	Description
SAP

BusinessApplicationAgentResource

Objeto

Descreve a configuração de um Agente de Aplicativo De Negócios.

Nome	Tipo	Description
etag	string	Etag do recurso do azure
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.agentSystems	AgentSystem[]	Descreve a configuração de um sistema dentro do agente.
properties.configuration	AgentConfiguration: SapAgentConfiguration	Descreve a configuração de um Agente de Aplicativo De Negócios.
properties.displayName	string minLength: 1
properties.lastModifiedTimeUtc	string (date-time)
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

CloudError

Objeto

Estrutura de resposta de erro.

Nome	Tipo	Description
error	CloudErrorBody	Dados de erro

CloudErrorBody

Objeto

Detalhes do erro.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

KeyVaultAuthenticationMode

Enumeração

Tipo de identidade de autenticação para o cofre de chaves

Valor	Description
ManagedIdentity
ServicePrincipal

SapAgentConfiguration

Objeto

Descreve a configuração de um agente do Docker SAP.

Nome	Tipo	Description
agentContainerName	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	O nome do agente do Docker. somente letras com números, sublinhados e hifens são permitidos exemplo: "meu agente"
keyVaultAuthenticationMode	KeyVaultAuthenticationMode	O modo de chave do agente. ManagedIdentity\|ApplicationIdentity são as opções
keyVaultResourceId	string pattern: ^\/?subscriptions\/([^\/]+)\/resourceGroups\/([^\/]+)\/providers\/Microsoft\.KeyVault\/vaults\/([^\/]+)$	A ID do recurso do cofre de chaves para acessar o cofre de chaves. exemplo: "/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)$	O caminho do SDK (um arquivo não uma pasta) no computador do agente. exemplo: "/path/to/nwrfc750P_8-70002755.zip"
secretSource	SecretSource	A fonte secreta do agente. AzureKeyVault é a opção
sncPath	string pattern: ^\/(?:[^/]+\/)[^/]+$\|^(?:[a-zA-Z]:)?(?:\\\|\\\\)(?:[^\\/:?"<>\|\r\n]+\\)[^\\/:?"<>\|\r\n]*$	O caminho SNC (uma pasta não um arquivo) no computador do agente. exemplo: "/path/to/snc"
type	AgentType	Tipo do agente

SecretSource

Enumeração

Tipo de fonte secreta – Azure Key Vault

Valor	Description
AzureKeyVault

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Business Application Agents - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

BusinessApplicationAgents_CreateOrUpdate

Solicitação de exemplo

Resposta de exemplo

Definições

AgentSystem

AgentType

BusinessApplicationAgentResource

CloudError

CloudErrorBody

createdByType

KeyVaultAuthenticationMode

SapAgentConfiguration

SecretSource

systemData