你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Systems - List

ListAll 系统。

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
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 参数

名称 必需 类型 说明
agentResourceName
path True

string

minLength: 3
maxLength: 63
pattern: ^[a-z0-9,-]*$

业务应用程序代理名称

resourceGroupName
path True

string

minLength: 1
maxLength: 90

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。

workspaceName
path True

string

minLength: 1
maxLength: 90
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

工作区的名称。

api-version
query True

string

minLength: 1

用于此操作的 API 版本。

$filter
query

string

根据布尔条件筛选结果。 可选。

$skipToken
query

string

仅当以前的作返回了部分结果时,才使用 Skiptoken。 如果以前的响应包含 nextLink 元素,则 nextLink 元素的值将包含一个 skiptoken 参数,该参数指定用于后续调用的起点。 可选。

响应

名称 类型 说明
200 OK

SystemsList

还行

Other Status Codes

CloudError

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Systems_List

示例请求

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

示例响应

{
  "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"
      }
    }
  ]
}

定义

名称 说明
CloudError

错误响应结构。

CloudErrorBody

错误详细信息。

ConfigurationType

表示系统的配置类型。

createdByType

创建资源的标识的类型。

HttpsConfigurationType

表示要连接到 SapControl 服务的 HTTPS 配置类型。

IngestionType

引入的类型。

Log

描述日志。

LogStatusType

日志状态的类型。

LogType

日志和表的类型。

RfcConnector

描述 Rfc 连接器。

SapAuthenticationType

向 SAP 进行身份验证的类型。

SapControlConnector

介绍 SapControl 连接器配置。

SapSystemsConfiguration

描述 SAP 配置。

SystemConfigurationConnectorType

表示 SAP 系统的类型。

systemData

与创建和上次修改资源相关的元数据。

SystemResource

描述代理中的系统。

SystemsList

代理的系统列表。

SystemStatusType

系统的状态。

CloudError

错误响应结构。

名称 类型 说明
error

CloudErrorBody

错误数据

CloudErrorBody

错误详细信息。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

message

string

描述错误的消息,旨在适合在用户界面中显示。

ConfigurationType

表示系统的配置类型。

说明
SAP

createdByType

创建资源的标识的类型。

说明
User
Application
ManagedIdentity
Key

HttpsConfigurationType

表示要连接到 SapControl 服务的 HTTPS 配置类型。

说明
HttpOnly
HttpsWithSslVerification
HttpsWithoutSslVerification

IngestionType

引入的类型。

说明
Full
Incremental

Log

描述日志。

名称 类型 说明
bulkSize

integer (int32)

日志的大容量大小。

filters

string[]

日志的筛选器。

ingestionType

IngestionType

引入的类型。

scheduleInterval

integer (int32)

计划间隔(以秒为单位)。

status

LogStatusType

日志状态的类型。

type

LogType

日志和表的类型。

LogStatusType

日志状态的类型。

说明
Enabled
Disabled

LogType

日志和表的类型。

说明
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

描述 Rfc 连接器。

名称 类型 说明
abapServerHost

string

ABAP 服务器的 FQDN、主机名或 IP 地址。

authenticationType

SapAuthenticationType

SAP 的身份验证类型。

client

string

minLength: 1
pattern: ^[0-9]{3}$

ABAP 服务器的客户端编号。 示例 - 001

codePage

string

pattern: ^(?:[a-zA-Z0-9]{4}|UTF-8)$

用于字符编码的 SAP 代码页。 示例 - 1100

group

string

消息服务器的登录组。

messageServerHost

string

消息服务器的 FQDN、主机名或 IP 地址。

messageServerService

string

消息服务器的端口号或服务名称(来自 /etc/services)。

sncQop

string

pattern: ^[1,2,3,8,9]$

SNC QOP。 选项为 1、2、3、8、9。

systemId

string

minLength: 1
pattern: ^[a-zA-Z0-9]{3}$

ABAP 服务器的系统 ID。 示例 - A4H

systemNumber

string

minLength: 1
pattern: ^\d{1,3}$

ABAP 服务器的系统编号。

type

SystemConfigurationConnectorType

表示 SAP 系统的类型。

SapAuthenticationType

向 SAP 进行身份验证的类型。

说明
UsernamePassword
Snc
SncWithUsernamePassword

SapControlConnector

介绍 SapControl 连接器配置。

名称 类型 默认值 说明
httpsConfiguration

HttpsConfigurationType

表示要连接到 SapControl 服务的 HTTPS 配置类型。

instance

string

minLength: 1
pattern: ^\d{2}$

实例编号。 仅允许 2 位数字。

port

string

pattern: ^\d{1,5}$

与 SAP 控件的 SOAP 连接的端口。

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}$

服务器名称 FQDN 或 IP 地址。

timezone

string

pattern: ^GMT[+-]\d+$
GMT+0

时区。 示例:“GMT+0”或“GMT-8”默认值:“GMT+0”

type

SystemConfigurationConnectorType

表示 SAP 系统的类型。

SapSystemsConfiguration

描述 SAP 配置。

名称 类型 说明
azureResourceId

string

pattern: ^\/?subscriptions\/([^\/]+)\/resourceGroups\/([^\/]+)\/providers\/([^\/]+)\/([^\/]+)\/([^\/]+)$

azure 资源 ID 示例:“/subscriptions/0000000-0000-0000-0000-00000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM”

connector SystemsConfigurationConnector:

SAP 系统连接器的基本模型。

logs

Log[]

日志配置。

type

ConfigurationType

表示系统的配置类型。

SystemConfigurationConnectorType

表示 SAP 系统的类型。

说明
Rfc
SapControl

systemData

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

上次修改的资源时间戳(UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。

SystemResource

描述代理中的系统。

名称 类型 说明
etag

string

Azure 资源的 Etag

id

string (arm-id)

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

name

string

资源的名称

properties.configuration SystemsConfiguration:

SapSystemsConfiguration

系统的配置。

properties.displayName

string

minLength: 1
properties.lastModifiedTimeUtc

string (date-time)

properties.status

SystemStatusType

系统的状态。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SystemsList

代理的系统列表。

名称 类型 说明
nextLink

string

value

SystemResource[]

描述代理中的系统。

SystemStatusType

系统的状态。

说明
Running
Stopped