Microsoft.SecurityInsights/dataConnectors 2022-12-01-preview - Bicep, ARM template & Terraform AzAPI reference

Bicep 資源定義

dataConnectors 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.SecurityInsights/dataConnectors 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.SecurityInsights/dataConnectors@2022-12-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'
  }
}

針對 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'
  }
}

針對 MicrosoftThreatIntelligence，請使用：

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

針對 MicrosoftThreatProtection，請使用：

{
  kind: 'MicrosoftThreatProtection'
  properties: {
    dataTypes: {
      incidents: {
        state: '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' （必要）
性能	AAD （Azure Active Directory）資料連接器屬性。	AADDataConnectorProperties

AADDataConnectorProperties

名字	描述	價值
dataTypes	連接器的可用數據類型。	AlertsDataTypeOfDataConnector
tenantId	要連線的租用戶標識碼，並從中取得數據。	字串（必要）

AatpDataConnector

名字	描述	價值
類	數據連接器種類	'AzureAdvancedThreatProtection' （必要）
性能	AATP （Azure 進階威脅防護）資料連接器屬性。	AatpDataConnectorProperties

AatpDataConnectorProperties

名字	描述	價值
dataTypes	連接器的可用數據類型。	AlertsDataTypeOfDataConnector
tenantId	要連線的租用戶標識碼，並從中取得數據。	字串（必要）

AlertsDataTypeOfDataConnector

名字	描述	價值
警報	警示數據類型連線。	DataConnectorDataTypeCommon （必要）

ApiPollingParameters

名字	描述	價值
connectorUiConfig	設定以描述指示刀鋒視窗	CodelessUiConnectorConfigProperties
pollingConfig	設定以描述輪詢指示	CodelessConnectorPollingConfigProperties

ASCDataConnector

名字	描述	價值
類	數據連接器種類	'AzureSecurityCenter' （必要）
性能	ASC （Azure 資訊安全中心）資料連接器屬性。	ASCDataConnectorProperties

ASCDataConnectorProperties

名字	描述	價值
dataTypes	連接器的可用數據類型。	AlertsDataTypeOfDataConnector
subscriptionId	要連線的訂用帳戶標識碼，並從中取得數據。	字串

可用性

名字	描述	價值
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 中的記錄目的地數據表名稱。	字串（必要）
roleArn	用來存取 Aws 帳戶的 Aws 角色 Arn。	字串（必要）
sqsUrls	連接器的 AWS sqs URL。	string[] （必要）

CodelessApiPollingDataConnector

名字	描述	價值
類	數據連接器種類	'APIPolling' （必要）
性能	無程式代碼擷取數據連接器屬性	ApiPollingParameters

CodelessConnectorPollingAuthProperties

名字	描述	價值
apiKeyIdentifier	在實際令牌之前，標頭中傳送前置詞	字串
apiKeyName	用來傳送令牌的標頭名稱	字串
authorizationEndpoint	用來授權使用者的端點，用於 Oauth 2.0 流程	字串
authorizationEndpointQueryParameters	授權要求中使用的查詢參數，用於 Oauth 2.0 流程	任何
authType	驗證類型	字串（必要）
flowName	描述流程名稱，例如 Oauth 2.0 的 'AuthCode'	字串
isApiKeyInPostPayload	標記索引鍵是否應該在標頭中傳送	字串
isClientSecretInHeader	標記我們應該在標頭或承載中傳送客戶端密碼，用於 Oauth 2.0 流程	bool
redirectionEndpoint	我們將在 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'	字串（必要）
searchTheLatestTimeStampFromEventsList	判斷是否要在事件清單中搜尋最新的時間戳	字串

CodelessConnectorPollingRequestProperties

名字	描述	價值
apiEndpoint	描述我們應該從中提取數據的端點	字串（必要）
endTimeAttributeName	這會使用時間範圍結尾的查詢事件	字串
頭	描述在輪詢要求中傳送的標頭	任何
httpMethod	我們將在輪詢要求、GET 或 POST 中使用的 HTTP 方法類型	字串（必要）
queryParameters	描述在輪詢要求中傳送的查詢參數	任何
queryParametersTemplate	針對進階案例，例如內嵌在巢狀 JSON 承載中的使用者名稱/密碼	字串
queryTimeFormat	時間格式將用於特定視窗中的查詢事件	字串（必要）
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	連接器描述	字串（必要）
graphQueries	顯示目前數據狀態的圖表查詢	CodelessUiConnectorConfigPropertiesGraphQueriesItem[] （必要）
graphQueriesTableName	連接器將插入數據至的數據表名稱	字串（必要）
instructionSteps	啟用連接器的指示步驟	CodelessUiConnectorConfigPropertiesInstructionStepsItem[] （必要）
權限	連接器所需的許可權	權限（必要）
發行人	連接器發行者名稱	字串（必要）
sampleQueries	連接器的範例查詢	CodelessUiConnectorConfigPropertiesSampleQueriesItem[] （必要）
標題	連接器刀鋒視窗標題	字串（必要）

CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem

名字	描述	價值
類型	線上類型	'IsConnectedQuery'
價值	檢查連線的查詢	string[]

CodelessUiConnectorConfigPropertiesDataTypesItem

名字	描述	價值
lastDataReceivedQuery	查詢以指出上次收到的數據	字串
名字	要顯示在圖形中的數據類型名稱。可以搭配 {{graphQueriesTableName}} 占位符使用	字串

CodelessUiConnectorConfigPropertiesGraphQueriesItem

名字	描述	價值
baseQuery	圖形的基底查詢	字串
傳說	圖形的圖例	字串
metricName	查詢正在檢查的計量	字串

CodelessUiConnectorConfigPropertiesInstructionStepsItem

名字	描述	價值
描述	指示步驟描述	字串
指示	指示步驟詳細數據	InstructionStepsInstructionsItem[]
標題	指示步驟標題	字串

CodelessUiConnectorConfigPropertiesSampleQueriesItem

名字	描述	價值
描述	範例查詢描述	字串
查詢	範例查詢	字串

CodelessUiDataConnector

名字	描述	價值
類	數據連接器種類	'GenericUI' （必要）
性能	無程式代碼 UI 資料連接器屬性	CodelessParameters

DataConnectorDataTypeCommon

名字	描述	價值
州	描述是否啟用此資料類型連線。	'Disabled' 'Enabled' （必要）

Dynamics365DataConnector

名字	描述	價值
類	數據連接器種類	'Dynamics365' （必要）
性能	Dynamics365 數據連接器屬性。	Dynamics365DataConnectorProperties

Dynamics365DataConnectorDataTypes

名字	描述	價值
dynamics365CdsActivities	Common Data Service 數據類型連接。	Dynamics365DataConnectorDataTypesDynamics365CdsActivities （必要）

Dynamics365DataConnectorDataTypesDynamics365CdsActivities

名字	描述	價值
州	描述是否啟用此資料類型連線。	'Disabled' 'Enabled' （必要）

Dynamics365DataConnectorProperties

名字	描述	價值
dataTypes	連接器的可用數據類型。	Dynamics365DataConnectorDataTypes （必要）
tenantId	要連線的租用戶標識碼，並從中取得數據。	字串（必要）

InstructionStepsInstructionsItem

名字	描述	價值
參數	設定的參數	任何
類型	設定的種類	'CopyableLabel' 'InfoMessage' 'InstructionStepsGroup' （必要）

IoTDataConnector

名字	描述	價值
類	數據連接器種類	'IOT' （必要）
性能	IoT 資料連接器屬性。	IoTDataConnectorProperties

IoTDataConnectorProperties

名字	描述	價值
dataTypes	連接器的可用數據類型。	AlertsDataTypeOfDataConnector
subscriptionId	要連線的訂用帳戶標識碼，並從中取得數據。	字串

McasDataConnector

名字	描述	價值
類	數據連接器種類	'MicrosoftCloudAppSecurity' （必要）
性能	MCAS （Microsoft Cloud App Security）資料連接器屬性。	McasDataConnectorProperties

McasDataConnectorDataTypes

名字	描述	價值
警報	警示數據類型連線。	DataConnectorDataTypeCommon （必要）
discoveryLogs	探索記錄數據類型連線。	DataConnectorDataTypeCommon

McasDataConnectorProperties

名字	描述	價值
dataTypes	連接器的可用數據類型。	McasDataConnectorDataTypes （必要）
tenantId	要連線的租用戶標識碼，並從中取得數據。	字串（必要）

MdatpDataConnector

名字	描述	價值
類	數據連接器種類	'MicrosoftDefenderAdvancedThreatProtection' （必要）
性能	MDATP （Microsoft Defender 進階威脅防護）資料連接器屬性。	MdatpDataConnectorProperties

MdatpDataConnectorProperties

名字	描述	價值
dataTypes	連接器的可用數據類型。	AlertsDataTypeOfDataConnector
tenantId	要連線的租用戶標識碼，並從中取得數據。	字串（必要）