Microsoft.SecurityInsights dataConnectors 2022-08-01-preview

Статья
12/20/2024

Определение ресурсов Bicep

Тип ресурса dataConnectors можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.SecurityInsights/dataConnectors, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.SecurityInsights/dataConnectors@2022-08-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 Advanced Threat Protection).	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

Имя	Описание	Ценность
государство	Опишите, включена ли подключение к этому типу данных.	"Отключено" "Включено" (обязательно)

AwsCloudTrailDataConnectorProperties

Имя	Описание	Ценность
awsRoleArn	Роль Aws (с политикой CloudTrailReadOnly), которая используется для доступа к учетной записи Aws.	струна
dataTypes	Доступные типы данных для соединителя.	AwsCloudTrailDataConnectorDataTypes (обязательно)

AwsS3DataConnector

Имя	Описание	Ценность
добрый	Тип соединителя данных	AmazonWebServicesS3 (обязательно)
свойства	Свойства соединителя данных Amazon Web Services S3.	AwsS3DataConnectorProperties

AwsS3DataConnectorDataTypes

Имя	Описание	Ценность
Журналы	Регистрирует тип данных.	AwsS3DataConnectorDataTypesLogs (обязательно)

AwsS3DataConnectorDataTypesLogs

Имя	Описание	Ценность
государство	Опишите, включена ли подключение к этому типу данных.	"Отключено" "Включено" (обязательно)

AwsS3DataConnectorProperties

Имя	Описание	Ценность
dataTypes	Доступные типы данных для соединителя.	AwsS3DataConnectorDataTypes (обязательно)
целеваяtable	Имя целевой таблицы журналов в LogAnalytics.	строка (обязательно)
roleArn	Роль Aws Arn, используемая для доступа к учетной записи Aws.	строка (обязательно)
sqsUrls	URL-адреса AWS sqs для соединителя.	string[] (обязательно)

CodelessApiPollingDataConnector

Имя	Описание	Ценность
добрый	Тип соединителя данных	APIPolling (обязательно)
свойства	Свойства соединителя данных без кода	ApiPollingParameters

CodelessConnectorPollingAuthProperties

Имя	Описание	Ценность
apiKeyIdentifier	Префикс, отправляемый в заголовке перед фактическим маркером	струна
apiKeyName	Имя заголовка, с которым отправляется маркер	струна
authorizationEndpoint	Конечная точка, используемая для авторизации пользователя, используемая в потоке Oauth 2.0	струна
authorizationEndpointQueryParameters	Параметры запроса, используемые в запросе авторизации, используемые в потоке Oauth 2.0	любой
authType	Тип проверки подлинности	строка (обязательно)
flowName	Описывает имя потока, например AuthCode для Oauth 2.0	струна
isApiKeyInPostPayload	Помечает, если ключ должен отправляться в заголовке	струна
isClientSecretInHeader	Помечает, следует ли отправлять секрет клиента в заголовке или полезных данных, используемых в потоке Oauth 2.0.	bool
redirectionEndpoint	Конечная точка перенаправления, в которой мы получим код авторизации, используемый в потоке Oauth 2.0	струна
размах	Область маркера OAuth	струна
tokenEndpoint	Конечная точка, используемая для выдачи маркера, используемая в потоке Oauth 2.0	струна
tokenEndpointHeaders	Заголовки запросов, используемые в запросе маркера, используемые в потоке Oauth 2.0	любой
tokenEndpointQueryParameters	Параметры запроса, используемые в запросе маркера, используемые в потоке Oauth 2.0	любой

CodelessConnectorPollingConfigProperties

Имя	Описание	Ценность
auth	Описание типа проверки подлинности опроса	CodelessConnectorPollingAuthProperties (обязательно)
isActive	Активное состояние опрашителя	bool
замещение страниц	Описание конфигурации запроса опроса на разбиение по страницам опроса для опроса	CodelessConnectorPollingPagingProperties
просьба	Описание параметров конфигурации запроса опроса для опрашителя	CodelessConnectorPollingRequestProperties (обязательно)
ответ	Описание параметров конфигурации ответа опрашителя	CodelessConnectorPollingResponseProperties

CodelessConnectorPollingPagingProperties

Имя	Описание	Ценность
nextPageParaName	Определяет имя атрибута следующей страницы	струна
nextPageTokenJsonPath	Определяет путь к следующему токену страницы JSON	струна
pageCountAttributePath	Определяет путь к атрибуту счетчика страниц	струна
pageSize	Определяет размер разбиения по страницам	int
pageSizeParaName	Определяет имя параметра размера страницы	струна
pageTimeStampAttributePath	Определяет путь к атрибуту метки времени разбиения по страницам	струна
pageTotalCountAttributePath	Определяет путь к атрибуту общего количества страниц	струна
разбиение по страницамType	Описывает тип. может быть "None", "PageToken", "PageCount", "TimeStamp"	строка (обязательно)
searchTheLatestTimeStampFromEventsList	Определяет, следует ли искать последнюю метку времени в списке событий.	струна

CodelessConnectorPollingRequestProperties

Имя	Описание	Ценность
apiEndpoint	Описать конечную точку, из нее следует извлечь данные	строка (обязательно)
endTimeAttributeName	Это будет использоваться события запроса с конца периода времени	струна
Заголовки	Описание заголовков, отправленных в запросе опроса	любой
httpMethod	Тип метода HTTP, который мы будем использовать в запросе опроса, GET или POST	строка (обязательно)
queryParameters	Описание параметров запроса, отправленных в запросе опроса	любой
queryParametersTemplate	Дополнительные сценарии, например имя пользователя или пароль, внедренные в вложенные полезные данные JSON	струна
queryTimeFormat	Формат времени будет использоваться для событий запроса в определенном окне	строка (обязательно)
queryWindowInMin	Интервал окна, который будет использоваться для извлечения данных	int (обязательно)
rateLimitQps	Определяет ограничение скорости QPS	int
Повторная попытка	Описать время, которое необходимо попробовать и происпрашить данные в случае сбоя	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	Имя таблицы соединителя вставляет данные в	строка (обязательно)
инструкцииSteps	Инструкции по включению соединителя	CodelessUiConnectorConfigPropertiesInstructionStepsItem[] (обязательно)
Разрешения	Разрешения, необходимые для соединителя	разрешения (обязательно)
издатель	Имя издателя соединителя	строка (обязательно)
sampleQueries	Примеры запросов для соединителя	CodelessUiConnectorConfigPropertiesSampleQueriesItem[] (обязательно)
титул	Заголовок колонки соединителя	строка (обязательно)

CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem

Имя	Описание	Ценность
тип	тип подключения	IsConnectedQuery
ценность	Запросы проверки подключения	string[]

CodelessUiConnectorConfigPropertiesDataTypesItem

Имя	Описание	Ценность
lastDataReceivedQuery	Запрос на указание последних полученных данных	струна
имя	Имя типа данных, отображаемого в графе. можно использовать с заполнителем {{graphQueriesTableName}}	струна

CodelessUiConnectorConfigPropertiesGraphQueriesItem

Имя	Описание	Ценность
baseQuery	Базовый запрос графа	струна
легенда	Условные обозначения для графа	струна
metricName	метрика, проверяемая запросом	струна

CodelessUiConnectorConfigPropertiesInstructionStepsItem

Имя	Описание	Ценность
описание	Описание шага инструкции	струна
резолюция	Сведения о шаге инструкции	ИнструкцииStepsInstructionsItem[]
титул	Заголовок шага инструкции	струна

CodelessUiConnectorConfigPropertiesSampleQueriesItem

Имя	Описание	Ценность
описание	Описание примера запроса	струна
запрос	пример запроса	струна

CodelessUiDataConnector

Имя	Описание	Ценность
добрый	Тип соединителя данных	GenericUI (обязательный)
свойства	Свойства соединителя данных пользовательского интерфейса без кода	CodelessParameters

DataConnectorDataTypeCommon

Имя	Описание	Ценность
государство	Опишите, включена ли подключение к этому типу данных.	"Отключено" "Включено" (обязательно)

Dynamics365DataConnector

Имя	Описание	Ценность
добрый	Тип соединителя данных	Dynamics365 (обязательный)
свойства	Свойства соединителя данных Dynamics365.	Dynamics365DataConnectorProperties

Dynamics365DataConnectorDataTypes

Имя	Описание	Ценность
dynamics365CdsActivities	Подключение типа данных Common Data Service.	Dynamics365DataConnectorDataTypesDynamics365CdsActivities (обязательно)

Dynamics365DataConnectorDataTypesDynamics365CdsActivities

Имя	Описание	Ценность
государство	Опишите, включена ли подключение к этому типу данных.	"Отключено" "Включено" (обязательно)

Dynamics365DataConnectorProperties

Имя	Описание	Ценность
dataTypes	Доступные типы данных для соединителя.	Dynamics365DataConnectorDataTypes (обязательно)
tenantId	Идентификатор клиента для подключения и получения данных.	строка (обязательно)

ИнструкцияStepsInstructionsItem

Имя	Описание	Ценность
Параметры	Параметры параметра	любой
тип	Тип параметра	CopyableLabel InfoMessage "ИнструкцияStepsGroup" (обязательный)

IoTDataConnector

Имя	Описание	Ценность
добрый	Тип соединителя данных	"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 Advanced Threat Protection).	mdatpDataConnectorProperties

MdatpDataConnectorProperties

Имя	Описание	Ценность
dataTypes	Доступные типы данных для соединителя.	AlertsDataTypeOfDataConnector
tenantId	Идентификатор клиента для подключения и получения данных.	строка (обязательно)