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

Microsoft.SecurityInsights dataConnectors 2023-07-01-preview

项目
12/20/2024

Bicep 资源定义

可以使用目标操作部署 dataConnectors 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.SecurityInsights/dataConnectors 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.SecurityInsights/dataConnectors@2023-07-01-preview' = {
  etag: 'string'
  name: 'string'
  kind: 'string'
  // For remaining properties, see Microsoft.SecurityInsights/dataConnectors objects
}

Microsoft.SecurityInsights/dataConnectors 对象

设置类型属性以指定对象的类型。

对于 APIPolling，请使用：

{
  kind: 'APIPolling'
  properties: {
    connectorUiConfig: {
      availability: {
        isPreview: bool
        status: '1'
      }
      connectivityCriteria: [
        {
          type: 'string'
          value: [
            'string'
          ]
        }
      ]
      customImage: 'string'
      dataTypes: [
        {
          lastDataReceivedQuery: 'string'
          name: 'string'
        }
      ]
      descriptionMarkdown: 'string'
      graphQueries: [
        {
          baseQuery: 'string'
          legend: 'string'
          metricName: 'string'
        }
      ]
      graphQueriesTableName: 'string'
      instructionSteps: [
        {
          description: 'string'
          instructions: [
            {
              parameters: any(Azure.Bicep.Types.Concrete.AnyType)
              type: 'string'
            }
          ]
          title: 'string'
        }
      ]
      permissions: {
        customs: [
          {
            description: 'string'
            name: 'string'
          }
        ]
        resourceProvider: [
          {
            permissionsDisplayText: 'string'
            provider: 'string'
            providerDisplayName: 'string'
            requiredPermissions: {
              action: bool
              delete: bool
              read: bool
              write: bool
            }
            scope: 'string'
          }
        ]
      }
      publisher: 'string'
      sampleQueries: [
        {
          description: 'string'
          query: 'string'
        }
      ]
      title: 'string'
    }
    pollingConfig: {
      auth: {
        apiKeyIdentifier: 'string'
        apiKeyName: 'string'
        authorizationEndpoint: 'string'
        authorizationEndpointQueryParameters: any(Azure.Bicep.Types.Concrete.AnyType)
        authType: 'string'
        flowName: 'string'
        isApiKeyInPostPayload: 'string'
        isClientSecretInHeader: bool
        redirectionEndpoint: 'string'
        scope: 'string'
        tokenEndpoint: 'string'
        tokenEndpointHeaders: any(Azure.Bicep.Types.Concrete.AnyType)
        tokenEndpointQueryParameters: any(Azure.Bicep.Types.Concrete.AnyType)
      }
      isActive: bool
      paging: {
        nextPageParaName: 'string'
        nextPageTokenJsonPath: 'string'
        pageCountAttributePath: 'string'
        pageSize: int
        pageSizeParaName: 'string'
        pageTimeStampAttributePath: 'string'
        pageTotalCountAttributePath: 'string'
        pagingType: 'string'
        searchTheLatestTimeStampFromEventsList: 'string'
      }
      request: {
        apiEndpoint: 'string'
        endTimeAttributeName: 'string'
        headers: any(Azure.Bicep.Types.Concrete.AnyType)
        httpMethod: 'string'
        queryParameters: any(Azure.Bicep.Types.Concrete.AnyType)
        queryParametersTemplate: 'string'
        queryTimeFormat: 'string'
        queryWindowInMin: int
        rateLimitQps: int
        retryCount: int
        startTimeAttributeName: 'string'
        timeoutInSeconds: int
      }
      response: {
        eventsJsonPaths: [
          'string'
        ]
        isGzipCompressed: bool
        successStatusJsonPath: 'string'
        successStatusValue: 'string'
      }
    }
  }
}

对于 AmazonWebServicesCloudTrail，请使用：

{
  kind: 'AmazonWebServicesCloudTrail'
  properties: {
    awsRoleArn: 'string'
    dataTypes: {
      logs: {
        state: 'string'
      }
    }
  }
}

对于 AmazonWebServicesS3，请使用：

{
  kind: 'AmazonWebServicesS3'
  properties: {
    dataTypes: {
      logs: {
        state: 'string'
      }
    }
    destinationTable: 'string'
    roleArn: 'string'
    sqsUrls: [
      'string'
    ]
  }
}

对于 AzureActiveDirectory，请使用：

{
  kind: 'AzureActiveDirectory'
  properties: {
    dataTypes: {
      alerts: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 AzureAdvancedThreatProtection，请使用：

{
  kind: 'AzureAdvancedThreatProtection'
  properties: {
    dataTypes: {
      alerts: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

若要 AzureSecurityCenter，请使用：

{
  kind: 'AzureSecurityCenter'
  properties: {
    dataTypes: {
      alerts: {
        state: 'string'
      }
    }
    subscriptionId: 'string'
  }
}

对于 Dynamics365，请使用：

{
  kind: 'Dynamics365'
  properties: {
    dataTypes: {
      dynamics365CdsActivities: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 GCP，请使用：

{
  kind: 'GCP'
  properties: {
    auth: {
      projectNumber: 'string'
      serviceAccountEmail: 'string'
      workloadIdentityProviderId: 'string'
    }
    connectorDefinitionName: 'string'
    dcrConfig: {
      dataCollectionEndpoint: 'string'
      dataCollectionRuleImmutableId: 'string'
      streamName: 'string'
    }
    request: {
      projectId: 'string'
      subscriptionNames: [
        'string'
      ]
    }
  }
}

对于 GenericUI，请使用：

{
  kind: 'GenericUI'
  properties: {
    connectorUiConfig: {
      availability: {
        isPreview: bool
        status: '1'
      }
      connectivityCriteria: [
        {
          type: 'string'
          value: [
            'string'
          ]
        }
      ]
      customImage: 'string'
      dataTypes: [
        {
          lastDataReceivedQuery: 'string'
          name: 'string'
        }
      ]
      descriptionMarkdown: 'string'
      graphQueries: [
        {
          baseQuery: 'string'
          legend: 'string'
          metricName: 'string'
        }
      ]
      graphQueriesTableName: 'string'
      instructionSteps: [
        {
          description: 'string'
          instructions: [
            {
              parameters: any(Azure.Bicep.Types.Concrete.AnyType)
              type: 'string'
            }
          ]
          title: 'string'
        }
      ]
      permissions: {
        customs: [
          {
            description: 'string'
            name: 'string'
          }
        ]
        resourceProvider: [
          {
            permissionsDisplayText: 'string'
            provider: 'string'
            providerDisplayName: 'string'
            requiredPermissions: {
              action: bool
              delete: bool
              read: bool
              write: bool
            }
            scope: 'string'
          }
        ]
      }
      publisher: 'string'
      sampleQueries: [
        {
          description: 'string'
          query: 'string'
        }
      ]
      title: 'string'
    }
  }
}

对于 IOT，请使用：

{
  kind: 'IOT'
  properties: {
    dataTypes: {
      alerts: {
        state: 'string'
      }
    }
    subscriptionId: 'string'
  }
}

对于 MicrosoftCloudAppSecurity，请使用：

{
  kind: 'MicrosoftCloudAppSecurity'
  properties: {
    dataTypes: {
      alerts: {
        state: 'string'
      }
      discoveryLogs: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 MicrosoftDefenderAdvancedThreatProtection，请使用：

{
  kind: 'MicrosoftDefenderAdvancedThreatProtection'
  properties: {
    dataTypes: {
      alerts: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 MicrosoftPurviewInformationProtection，请使用：

{
  kind: 'MicrosoftPurviewInformationProtection'
  properties: {
    dataTypes: {
      logs: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 MicrosoftThreatIntelligence，请使用：

{
  kind: 'MicrosoftThreatIntelligence'
  properties: {
    dataTypes: {
      microsoftEmergingThreatFeed: {
        lookbackPeriod: 'string'
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 MicrosoftThreatProtection，请使用：

{
  kind: 'MicrosoftThreatProtection'
  properties: {
    dataTypes: {
      alerts: {
        state: 'string'
      }
      incidents: {
        state: 'string'
      }
    }
    filteredProviders: {
      alerts: [
        'string'
      ]
    }
    tenantId: 'string'
  }
}

对于 Office365，请使用：

{
  kind: 'Office365'
  properties: {
    dataTypes: {
      exchange: {
        state: 'string'
      }
      sharePoint: {
        state: 'string'
      }
      teams: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 Office365Project，请使用：

{
  kind: 'Office365Project'
  properties: {
    dataTypes: {
      logs: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 OfficeATP，请使用：

{
  kind: 'OfficeATP'
  properties: {
    dataTypes: {
      alerts: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 OfficeIRM，请使用：

{
  kind: 'OfficeIRM'
  properties: {
    dataTypes: {
      alerts: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 OfficePowerBI，请使用：

{
  kind: 'OfficePowerBI'
  properties: {
    dataTypes: {
      logs: {
        state: 'string'
      }
    }
    tenantId: 'string'
  }
}

对于 ThreatIntelligence，请使用：

{
  kind: 'ThreatIntelligence'
  properties: {
    dataTypes: {
      indicators: {
        state: 'string'
      }
    }
    tenantId: 'string'
    tipLookbackPeriod: 'string'
  }
}

对于 ThreatIntelligenceTaxii，请使用：

{
  kind: 'ThreatIntelligenceTaxii'
  properties: {
    collectionId: 'string'
    dataTypes: {
      taxiiClient: {
        state: 'string'
      }
    }
    friendlyName: 'string'
    password: 'string'
    pollingFrequency: 'string'
    taxiiLookbackPeriod: 'string'
    taxiiServer: 'string'
    tenantId: 'string'
    userName: 'string'
    workspaceId: 'string'
  }
}

属性值

AADDataConnector

名字	描述	价值
类	数据连接器类型	“AzureActiveDirectory”（必需）
性能	AADIP （Azure Active Directory Identity Protection）数据连接器属性。	AADDataConnectorProperties

AADDataConnectorProperties

名字	描述	价值
dataTypes	连接器的可用数据类型。	AlertsDataTypeOfDataConnector
tenantId	要连接到的租户 ID，并从中获取数据。	string （必需）

AatpDataConnector

名字	描述	价值
类	数据连接器类型	“AzureAdvancedThreatProtection”（必需）
性能	AATP （Azure 高级威胁防护）数据连接器属性。	AatpDataConnectorProperties

AatpDataConnectorProperties

名字	描述	价值
dataTypes	连接器的可用数据类型。	AlertsDataTypeOfDataConnector
tenantId	要连接到的租户 ID，并从中获取数据。	string （必需）

AlertsDataTypeOfDataConnector

名字	描述	价值
警报	警报数据类型连接。	DataConnectorDataTypeCommon （必需）

ApiPollingParameters

名字	描述	价值
connectorUiConfig	描述说明边栏选项卡的配置	CodelessUiConnectorConfigProperties
pollingConfig	描述轮询说明的配置	CodelessConnectorPollingConfigProperties

ASCDataConnector

名字	描述	价值
类	数据连接器类型	“AzureSecurityCenter”（必需）
性能	ASC（Azure 安全中心）数据连接器属性。	ASCDataConnectorProperties

ASCDataConnectorProperties

名字	描述	价值
dataTypes	连接器的可用数据类型。	AlertsDataTypeOfDataConnector
subscriptionId	要连接到的订阅 ID，并从中获取数据。	字符串

可用性

名字	描述	价值
isPreview	将连接器设置为预览版	bool
地位	连接器可用性状态	'1'

AwsCloudTrailDataConnector

名字	描述	价值
类	数据连接器类型	“AmazonWebServicesCloudTrail”（必需）
性能	Amazon Web Services CloudTrail 数据连接器属性。	AwsCloudTrailDataConnectorProperties

AwsCloudTrailDataConnectorDataTypes

名字	描述	价值
原木	记录数据类型。	AwsCloudTrailDataConnectorDataTypesLogs（必需）

AwsCloudTrailDataConnectorDataTypesLogs

名字	描述	价值
州	描述是否启用此数据类型连接。	“Disabled” “Enabled”（必需）

AwsCloudTrailDataConnectorProperties

名字	描述	价值
awsRoleArn	用于访问 Aws 帐户的 Aws Role Arn（使用 CloudTrailReadOnly 策略）。	字符串
dataTypes	连接器的可用数据类型。	AwsCloudTrailDataConnectorDataTypes （必需）

AwsS3DataConnector

名字	描述	价值
类	数据连接器类型	“AmazonWebServicesS3”（必需）
性能	Amazon Web Services S3 数据连接器属性。	AwsS3DataConnectorProperties

AwsS3DataConnectorDataTypes

名字	描述	价值
原木	记录数据类型。	AwsS3DataConnectorDataTypesLogs （必需）

AwsS3DataConnectorDataTypesLogs

名字	描述	价值
州	描述是否启用此数据类型连接。	“Disabled” “Enabled”（必需）

AwsS3DataConnectorProperties

名字	描述	价值
dataTypes	连接器的可用数据类型。	AwsS3DataConnectorDataTypes （必需）
destinationTable	LogAnalytics 中的日志目标表名称。	string （必需）
roleArn	用于访问 Aws 帐户的 Aws 角色 Arn。	string （必需）
sqsUrls	连接器的 AWS sqs URL。	string[] （必需）

CodelessApiPollingDataConnector

名字	描述	价值
类	数据连接器类型	“APIPolling”（必需）
性能	无代码扑没数据连接器属性	ApiPollingParameters

CodelessConnectorPollingAuthProperties

名字	描述	价值
apiKeyIdentifier	在实际令牌之前在标头中发送前缀	字符串
apiKeyName	向其发送令牌的标头名称	字符串
authorizationEndpoint	用于授权用户在 Oauth 2.0 流中使用的终结点	字符串
authorizationEndpointQueryParameters	授权请求中使用的查询参数，用于 Oauth 2.0 流	任何
authType	身份验证类型	string （必需）
flowName	描述流名称，例如 Oauth 2.0 的“AuthCode”	字符串
isApiKeyInPostPayload	标记键是否应在标头中发送	字符串
isClientSecretInHeader	标记我们是否应在标头或有效负载中发送客户端密码（在 Oauth 2.0 流中使用）	bool
重定向Endpoint	将在其中获取 Oauth 2.0 流中使用的授权代码的重定向终结点	字符串
范围	OAuth 令牌范围	字符串
tokenEndpoint	用于颁发令牌的终结点，用于 Oauth 2.0 流	字符串
tokenEndpointHeaders	令牌请求中使用的查询标头，用于 Oauth 2.0 流	任何
tokenEndpointQueryParameters	令牌请求中使用的查询参数，用于 Oauth 2.0 流	任何

CodelessConnectorPollingConfigProperties

名字	描述	价值
认证	描述轮询器身份验证类型	CodelessConnectorPollingAuthProperties （必需）
isActive	轮询器活动状态	bool
寻呼	描述轮询程序分页配置	CodelessConnectorPollingPagingProperties
请求	描述轮询请求配置参数的轮询程序	CodelessConnectorPollingRequestProperties （必需）
响应	描述轮询器响应配置参数	CodelessConnectorPollingResponseProperties

CodelessConnectorPollingPagingProperties

名字	描述	价值
nextPageParaName	定义下一页属性的名称	字符串
nextPageTokenJsonPath	定义下一页令牌 JSON 的路径	字符串
pageCountAttributePath	定义页计数属性的路径	字符串
pageSize	定义分页大小	int
pageSizeParaName	定义页面大小参数的名称	字符串
pageTimeStampAttributePath	定义分页时间戳属性的路径	字符串
pageTotalCountAttributePath	定义页总计计数属性的路径	字符串
pagingType	描述类型。可以是“None”、“PageToken”、“PageCount”、“TimeStamp”	string （必需）
searchTheLatestTimeStampFromEventsList	确定是否在事件列表中搜索最新的时间戳	字符串

CodelessConnectorPollingRequestProperties

名字	描述	价值
apiEndpoint	描述应从中提取数据的终结点	string （必需）
endTimeAttributeName	这将使用时间窗口末尾的查询事件	字符串
头	描述在轮询请求中发送的标头	任何
httpMethod	我们将在轮询请求、GET 或 POST 中使用的 http 方法类型	string （必需）
queryParameters	描述在轮询请求中发送的查询参数	任何
queryParametersTemplate	对于高级方案，例如嵌入在嵌套 JSON 有效负载中的用户名/密码	字符串
queryTimeFormat	时间格式将用于特定窗口中的查询事件	string （必需）
queryWindowInMin	我们将使用拉取数据的窗口间隔	int （必需）
rateLimitQps	定义速率限制 QPS	int
retryCount	描述在发生故障时尝试和轮询数据的时间量	int
startTimeAttributeName	这将在时间窗口开始时使用查询事件	字符串
timeoutInSeconds	我们将被视为请求超时的秒数	int

CodelessConnectorPollingResponseProperties

名字	描述	价值
eventsJsonPaths	描述应在响应中提取数据的路径	string[] （必需）
isGzipCompressed	描述响应中的数据是否为 Gzip	bool
successStatusJsonPath	描述应在响应中提取状态代码的路径	字符串
successStatusValue	描述应在响应中提取状态值的路径	字符串

CodelessParameters

名字	描述	价值
connectorUiConfig	描述说明边栏选项卡的配置	CodelessUiConnectorConfigProperties

CodelessUiConnectorConfigProperties

名字	描述	价值
可用性	连接器可用性状态	可用性（必需）
connectivityCriteria	定义连接器检查连接的方式	CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem[] （必需）
customImage	在 Azure Sentinel 的连接器库中显示连接器时要使用的可选自定义图像	字符串
dataTypes	用于检查上次接收数据的数据类型	CodelessUiConnectorConfigPropertiesDataTypesItem[] （必需）
descriptionMarkdown	连接器说明	string （必需）
graphQueries	用于显示当前数据状态的图形查询	CodelessUiConnectorConfigPropertiesGraphQueriesItem[] （必需）
graphQueriesTableName	连接器将数据插入到的表的名称	string （必需）
instructionSteps	启用连接器的说明步骤	CodelessUiConnectorConfigPropertiesInstructionStepsItem[] （必需）
权限	连接器所需的权限	权限（必需）
发行人	连接器发布者名称	string （必需）
sampleQueries	连接器的示例查询	CodelessUiConnectorConfigPropertiesSampleQueriesItem[] （必需）
标题	连接器边栏选项卡标题	string （必需）

CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem

名字	描述	价值
类型	连接类型	“IsConnectedQuery”
价值	用于检查连接的查询	string[]

CodelessUiConnectorConfigPropertiesDataTypesItem

名字	描述	价值
lastDataReceivedQuery	查询指示收到的最后一个数据	字符串
名字	要显示在图形中的数据类型的名称。可与 {{graphQueriesTableName}} 占位符一起使用	字符串

CodelessUiConnectorConfigPropertiesGraphQueriesItem

名字	描述	价值
baseQuery	图形的基本查询	字符串
传说	图形的图例	字符串
metricName	查询正在检查的指标	字符串

CodelessUiConnectorConfigPropertiesInstructionStepsItem

名字	描述	价值
描述	说明步骤说明	字符串
指示	说明步骤详细信息	InstructionStepsInstructionsItem[]
标题	说明步骤标题	字符串

CodelessUiConnectorConfigPropertiesSampleQueriesItem

名字	描述	价值
描述	示例查询说明	字符串
查询	示例查询	字符串

CodelessUiDataConnector

名字	描述	价值
类	数据连接器类型	“GenericUI”（必需）
性能	无代码 UI 数据连接器属性	CodelessParameters

DataConnectorDataTypeCommon

名字	描述	价值
州	描述是否启用此数据类型连接。	“Disabled” “Enabled”（必需）

DCRConfiguration

名字	描述	价值
dataCollectionEndpoint	表示 Log Analytics 中的数据收集引入终结点。	string （必需）
dataCollectionRuleImmutableId	数据收集规则不可变 ID，规则定义转换和数据目标。	string （必需）
streamName	要向其发送数据的流。	string （必需）

Dynamics365DataConnector

名字	描述	价值
类	数据连接器类型	“Dynamics365”（必需）
性能	Dynamics365 数据连接器属性。	Dynamics365DataConnectorProperties

Dynamics365DataConnectorDataTypes

名字	描述	价值
dynamics365CdsActivities	Common Data Service 数据类型连接。	Dynamics365DataConnectorDataTypesDynamics365CdsActivities （必需）

Dynamics365DataConnectorDataTypesDynamics365CdsActivities

名字	描述	价值
州	描述是否启用此数据类型连接。	“Disabled” “Enabled”（必需）

Dynamics365DataConnectorProperties

名字	描述	价值
dataTypes	连接器的可用数据类型。	Dynamics365DataConnectorDataTypes （必需）
tenantId	要连接到的租户 ID，并从中获取数据。	string （必需）

GCPAuthProperties

名字	描述	价值
projectNumber	GCP 项目编号。	string （必需）
serviceAccountEmail	用于访问 GCP 项目的服务帐户。	string （必需）
workloadIdentityProviderId	用于获取 GCP 项目访问权限的工作负荷标识提供者 ID。	string （必需）

GCPDataConnector

名字	描述	价值
类	数据连接器类型	“GCP”（必需）
性能	Google Cloud Platform 数据连接器属性。	GCPDataConnectorProperties

GCPDataConnectorProperties

名字	描述	价值
认证	连接器的身份验证部分。	GCPAuthProperties（必需）
connectorDefinitionName	表示 UI 配置的连接器定义的名称。	string （必需）
dcrConfig	数据的目标的配置。	DCRConfiguration
请求	连接器的请求部分。	GCPRequestProperties （必需）

GCPRequestProperties

名字	描述	价值
projectId	GCP 项目 ID。	string （必需）
subscriptionNames	GCP pub/sub 订阅名称。	string[] （必需）

InstructionStepsInstructionsItem

名字	描述	价值
参数	设置的参数	任何
类型	设置的类型	“CopyableLabel” “InfoMessage” “InstructionStepsGroup”（必需）

IoTDataConnector

名字	描述	价值
类	数据连接器类型	“IOT”（必需）
性能	IoT 数据连接器属性。	IoTDataConnectorProperties

IoTDataConnectorProperties

名字	描述	价值
dataTypes	连接器的可用数据类型。	AlertsDataTypeOfDataConnector
subscriptionId	要连接到的订阅 ID，并从中获取数据。	字符串

McasDataConnector

名字	描述	价值
类	数据连接器类型	“MicrosoftCloudAppSecurity”（必需）
性能	MCAS（Microsoft Cloud App Security）数据连接器属性。	McasDataConnectorProperties

McasDataConnectorDataTypes

名字	描述	价值
警报	警报数据类型连接。	DataConnectorDataTypeCommon （必需）
discoveryLogs	发现日志数据类型连接。	DataConnectorDataTypeCommon

McasDataConnectorProperties

名字	描述	价值
dataTypes	连接器的可用数据类型。	McasDataConnectorDataTypes （必需）
tenantId	要连接到的租户 ID，并从中获取数据。	string （必需）

MdatpDataConnector

名字	描述	价值
类	数据连接器类型	“MicrosoftDefenderAdvancedThreatProtection”（必需）
性能	MDATP（Microsoft Defender 高级威胁防护）数据连接器属性。	MdatpDataConnectorProperties

MdatpDataConnectorProperties

名字	描述	价值
dataTypes	连接器的可用数据类型。	AlertsDataTypeOfDataConnector
tenantId	要连接到的租户 ID，并从中获取数据。	string （必需）