Microsoft.SecurityInsights dataConnectors 2024-09-01

Artigo
12/16/2024

Definição de recursos do bíceps

O tipo de recurso dataConnectors pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.SecurityInsights/dataConnectors, adicione o seguinte Bicep ao seu modelo.

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

Objetos CcpAuthConfig

Defina a propriedade type para especificar o tipo de objeto.

Para APIKey, use:

{
  apiKey: 'string'
  apiKeyIdentifier: 'string'
  apiKeyName: 'string'
  isApiKeyInPostPayload: bool
  type: 'APIKey'
}

Para AWS, use:

{
  externalId: 'string'
  roleArn: 'string'
  type: 'AWS'
}

Para Básico, utilize:

{
  password: 'string'
  type: 'Basic'
  userName: 'string'
}

Para GCP, use:

{
  projectNumber: 'string'
  serviceAccountEmail: 'string'
  type: 'GCP'
  workloadIdentityProviderId: 'string'
}

Para do GitHub, use:

{
  installationId: 'string'
  type: 'GitHub'
}

Para JwtToken , use:

{
  headers: {
    {customized property}: 'string'
  }
  isCredentialsInHeaders: bool
  isJsonRequest: bool
  password: {
    {customized property}: 'string'
  }
  queryParameters: {
    {customized property}: 'string'
  }
  requestTimeoutInSeconds: int
  tokenEndpoint: 'string'
  type: 'JwtToken'
  userName: {
    {customized property}: 'string'
  }
}

Para Nenhum, use:

{
  type: 'None'
}

Para OAuth2 , use:

{
  accessTokenPrepend: 'string'
  authorizationCode: 'string'
  authorizationEndpoint: 'string'
  authorizationEndpointHeaders: {
    {customized property}: 'string'
  }
  authorizationEndpointQueryParameters: {
    {customized property}: 'string'
  }
  clientId: 'string'
  clientSecret: 'string'
  grantType: 'string'
  isCredentialsInHeaders: bool
  isJwtBearerFlow: bool
  redirectUri: 'string'
  scope: 'string'
  tokenEndpoint: 'string'
  tokenEndpointHeaders: {
    {customized property}: 'string'
  }
  tokenEndpointQueryParameters: {
    {customized property}: 'string'
  }
  type: 'OAuth2'
}

Para Oracle, use:

{
  pemFile: 'string'
  publicFingerprint: 'string'
  tenantId: 'string'
  type: 'Oracle'
  userId: 'string'
}

Para ServiceBus, use:

{
  credentialsConfig: {
    {customized property}: 'string'
  }
  storageAccountCredentialsConfig: {
    {customized property}: 'string'
  }
  type: 'ServiceBus'
}

Para Sessão, use:

{
  headers: {
    {customized property}: 'string'
  }
  isPostPayloadJson: bool
  password: {
    {customized property}: 'string'
  }
  queryParameters: {
    {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
  }
  sessionIdName: 'string'
  sessionLoginRequestUri: 'string'
  sessionTimeoutInMinutes: int
  type: 'Session'
  userName: {
    {customized property}: 'string'
  }
}

Objetos Microsoft.SecurityInsights/dataConnectors

Defina a propriedade kind para especificar o tipo de objeto.

Para AmazonWebServicesCloudTrail , use:

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

Para AzureActiveDirectory, use:

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

Para AzureAdvancedThreatProtection , use:

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

Para AzureSecurityCenter , use:

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

Para MicrosoftCloudAppSecurity , use:

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

Para MicrosoftDefenderAdvancedThreatProtection , use:

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

Para MicrosoftThreatIntelligence , use:

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

Para do Office365 , use:

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

Para PremiumMicrosoftDefenderForThreatIntelligence , use:

{
  kind: 'PremiumMicrosoftDefenderForThreatIntelligence'
  properties: {
    dataTypes: {
      connector: {
        state: 'string'
      }
    }
    lookbackPeriod: 'string'
    requiredSKUsPresent: bool
    tenantId: 'string'
  }
}

Para RestApiPoller, use:

{
  kind: 'RestApiPoller'
  properties: {
    addOnAttributes: {
      {customized property}: 'string'
    }
    auth: {
      type: 'string'
      // For remaining properties, see CcpAuthConfig objects
    }
    connectorDefinitionName: 'string'
    dataType: 'string'
    dcrConfig: {
      dataCollectionEndpoint: 'string'
      dataCollectionRuleImmutableId: 'string'
      streamName: 'string'
    }
    isActive: bool
    paging: {
      pageSize: int
      pageSizeParameterName: 'string'
      pagingType: 'string'
    }
    request: {
      apiEndpoint: 'string'
      endTimeAttributeName: 'string'
      headers: {
        {customized property}: 'string'
      }
      httpMethod: 'string'
      isPostPayloadJson: bool
      queryParameters: {
        {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
      }
      queryParametersTemplate: 'string'
      queryTimeFormat: 'string'
      queryTimeIntervalAttributeName: 'string'
      queryTimeIntervalDelimiter: 'string'
      queryTimeIntervalPrepend: 'string'
      queryWindowInMin: int
      rateLimitQPS: int
      retryCount: int
      startTimeAttributeName: 'string'
      timeoutInSeconds: int
    }
    response: {
      compressionAlgo: 'string'
      convertChildPropertiesToArray: bool
      csvDelimiter: 'string'
      csvEscape: 'string'
      eventsJsonPaths: [
        'string'
      ]
      format: 'string'
      hasCsvBoundary: bool
      hasCsvHeader: bool
      isGzipCompressed: bool
      successStatusJsonPath: 'string'
      successStatusValue: 'string'
    }
  }
}

Para ThreatIntelligence , use:

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

Valores de propriedade

AADDataConnector

Designação	Descrição	Valor
tipo	O tipo de conector de dados	'AzureActiveDirectory' (obrigatório)
propriedades	Propriedades do conector de dados do AAD (Azure Ative Directory).	AADDataConnectorProperties

AADDataConnectorProperties

Designação	Descrição	Valor
Tipos de dados	Os tipos de dados disponíveis para o conector.	AlertsDataTypeOfDataConnector
inquilinoId	O ID do locatário ao qual se conectar e obter os dados.	string

AatpDataConnector

Designação	Descrição	Valor
tipo	O tipo de conector de dados	'AzureAdvancedThreatProtection' (obrigatório)
propriedades	Propriedades do conector de dados AATP (Azure Advanced Threat Protection).	AatpDataConnectorProperties

AatpDataConnectorPropriedades

Designação	Descrição	Valor
Tipos de dados	Os tipos de dados disponíveis para o conector.	AlertsDataTypeOfDataConnector
inquilinoId	O ID do locatário ao qual se conectar e obter os dados.	string

AlertsDataTypeOfDataConnector

Designação	Descrição	Valor
alertas	Alerta a conexão do tipo de dados.	DataConnectorDataTypeCommon

ApiKeyAuthModel

Designação	Descrição	Valor
apiKey	Chave de API para a credencial de chave secreta do usuário	string (obrigatório)
apiKeyIdentifier	Identificador de chave de API	string
apiKeyName	Nome da chave da API	string (obrigatório)
isApiKeyInPostPayload	Sinalizador para indicar se a chave da API está definida na carga HTTP POST	Bool
tipo	O tipo de autenticação	'APIKey' (obrigatório)

ASCDataConnector

Designação	Descrição	Valor
tipo	O tipo de conector de dados	'AzureSecurityCenter' (obrigatório)
propriedades	Propriedades do conector de dados ASC (Central de Segurança do Azure).	ASCDataConnectorProperties

ASCDataConnectorPropriedades

Designação	Descrição	Valor
Tipos de dados	Os tipos de dados disponíveis para o conector.	AlertsDataTypeOfDataConnector
subscriptionId	A ID da assinatura à qual se conectar e obter os dados.	string

AWSAuthModel

Designação	Descrição	Valor
Identificação externa	O AWS STS assume a função de ID externo. Isto é usado para evitar o problema confuso do deputado: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html'	string
papelArn	AWS STS assume função ARN	string (obrigatório)
tipo	O tipo de autenticação	'AWS' (obrigatório)

AwsCloudTrailDataConnector

Designação	Descrição	Valor
tipo	O tipo de conector de dados	'AmazonWebServicesCloudTrail' (obrigatório)
propriedades	Propriedades do conector de dados do Amazon Web Services CloudTrail.	AwsCloudTrailDataConnectorProperties

AwsCloudTrailDataConnectorDataTypes

Designação	Descrição	Valor
registos	Registra o tipo de dados.	AwsCloudTrailDataConnectorDataTypesLogs

AwsCloudTrailDataConnectorDataTypesLogs

Designação	Descrição	Valor
Estado	Descreva se essa conexão de tipo de dados está habilitada ou não.	'Desativado' 'Habilitado'

AwsCloudTrailDataConnectorProperties

Designação	Descrição	Valor
awsRoleArn	O Aws Role Arn (com a política CloudTrailReadOnly) que é usado para acessar a conta da AWS.	string
Tipos de dados	Os tipos de dados disponíveis para o conector.	AwsCloudTrailDataConnectorDataTypes

BasicAuthModel

Designação	Descrição	Valor
palavra-passe	A palavra-passe	string (obrigatório)
tipo	O tipo de autenticação	'Básico' (obrigatório)
nome de utilizador	O nome de usuário.	string (obrigatório)

CcpAuthConfig

Designação	Descrição	Valor
tipo	Defina como 'APIKey' para o tipo ApiKeyAuthModel. Defina como 'AWS' para o tipo AWSAuthModel. Defina como 'Basic' para o tipo BasicAuthModel. Defina como 'GCP' para o tipo GCPAuthModel. Defina como 'GitHub' para o tipo GitHubAuthModel. Defina como 'JwtToken' para o tipo JwtAuthModel. Defina como 'Nenhum' para o tipo NoneAuthModel. Defina como 'OAuth2' para o tipo OAuthModel. Defina como 'Oracle' para o tipo OracleAuthModel. Defina como 'ServiceBus' para o tipo GenericBlobSbsAuthModel. Defina como 'Session' para o tipo SessionAuthModel.	'APIKey' 'AWS' 'Básico' 'GCP' 'GitHub' 'JwtToken' 'Nenhuma' 'OAuth2' 'Oráculo' 'Barramento de serviço' 'Sessão' (obrigatório)

CcpResponseConfig

Designação	Descrição	Valor
compressãoAlgo	O algoritmo de compressão. Por exemplo: 'gzip', 'multi-gzip', 'deflate'.	string
convertChildPropertiesToArray	O valor que indica se a resposta não é uma matriz de eventos/logs. Ao definir esse sinalizador como true, significa que o servidor remoto responderá com um objeto que cada propriedade tem como valor uma matriz de eventos / logs.	Bool
csvDelimiter	O delimitador csv, caso o formato de resposta seja CSV.	string
csvEscape	O caractere usado para escapar de caracteres em CSV.	string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1
eventosJsonPaths	Os caminhos json, '$' char é a raiz json.	string[] (obrigatório)
Formato	O formato da resposta. Os valores possíveis são json,csv,xml	string
hasCsvBoundary	O valor que indica se a resposta tem limite CSV no caso da resposta no formato CSV.	Bool
hasCsvHeader	O valor que indica se a resposta tem cabeçalhos caso a resposta esteja no formato CSV.	Bool
isGzipComprimido	O valor que indica se o servidor remoto suporta Gzip e devemos esperar resposta Gzip.	Bool
successStatusJsonPath	O valor onde a mensagem/código de status deve aparecer na resposta.	string
successStatusValue	O valor de status.	string

DataConnectorDataTypeCommon

Designação	Descrição	Valor
Estado	Descreva se essa conexão de tipo de dados está habilitada ou não.	'Desativado' 'Habilitado'

DCRConfiguração

Designação	Descrição	Valor
dataCollectionEndpoint	Representa o ponto de extremidade de ingestão de coleta de dados na análise de log.	string (obrigatório)
dataCollectionRuleImmutableId	A regra de coleta de dados id imutável, a regra define a transformação e o destino dos dados.	string (obrigatório)
nome do fluxo	O fluxo para o qual estamos enviando os dados.	string (obrigatório)

GCPAuthModel

Designação	Descrição	Valor
número do projeto	Número do projeto GCP	string (obrigatório)
serviceAccountEmail	E-mail da conta de serviço GCP	string (obrigatório)
tipo	O tipo de autenticação	«GCP» (obrigatório)
workloadIdentityProviderId	ID do provedor de identidade de carga de trabalho do GCP	string (obrigatório)

GenericBlobSbsAuthModel

Designação	Descrição	Valor
credenciaisConfig	Credenciais para namespace do barramento de serviço, uri keyvault para chave de acesso	GenericBlobSbsAuthModelCredentialsConfig
storageAccountCredentialsConfig	Credenciais para conta de armazenamento, keyvault uri para chave de acesso	GenericBlobSbsAuthModelStorageAccountCredentialsConfig
tipo	O tipo de autenticação	'ServiceBus' (obrigatório)

GenericBlobSbsAuthModelCredentialsConfig

Designação	Descrição	Valor

GenericBlobSbsAuthModelStorageAccountCredentialsConfig

Designação	Descrição	Valor

GitHubAuthModel

Designação	Descrição	Valor
installationId	A ID de instalação de autenticação do GitHubApp.	string
tipo	O tipo de autenticação	'GitHub' (obrigatório)

JwtAuthModel

Designação	Descrição	Valor
cabeçalhos	Os cabeçalhos personalizados que queremos adicionar assim que enviarmos a solicitação para o ponto de extremidade do token.	JwtAuthModelHeaders
isCredentialsInHeaders	Sinalizador que indica se queremos enviar o nome de usuário e a senha para o ponto de extremidade do token nos cabeçalhos.	Bool
isJsonRequest	Sinalizador que indica se a solicitação de corpo é JSON (header Content-Type = application/json), o que significa que é uma solicitação codificada de URL de formulário (header Content-Type = application/x-www-form-urlencoded).	Bool
palavra-passe	A palavra-passe	JwtAuthModelPassword (obrigatório)
queryParameters	O parâmetro de consulta personalizada que queremos adicionar assim que enviarmos a solicitação para o ponto de extremidade do token.	JwtAuthModelQueryParameters
requestTimeoutInSeconds	Tempo limite de solicitação em segundos.	Int Restrições: Valor máximo = 180
tokenEndpoint	Ponto de extremidade de token para solicitar JWT	string (obrigatório)
tipo	O tipo de autenticação	'JwtToken' (obrigatório)
nome de utilizador	O nome de usuário. Se o nome de usuário e a senha enviados na solicitação de cabeçalho, só precisamos preencher a propriedade `value` com o nome de usuário (o mesmo que autenticação básica). Se o nome de usuário e senha enviados no corpo solicitar, precisamos especificar o `Key` e `Value`.	JwtAuthModelUserName (obrigatório)

JwtAuthModelHeaders

Designação	Descrição	Valor

JwtAuthModelPassword

Designação	Descrição	Valor

JwtAuthModelQueryParameters

Designação	Descrição	Valor

JwtAuthModelUserName

Designação	Descrição	Valor

McasDataConnector

Designação	Descrição	Valor
tipo	O tipo de conector de dados	'MicrosoftCloudAppSecurity' (obrigatório)
propriedades	Propriedades do conector de dados MCAS (Microsoft Cloud App Security).	McasDataConnectorProperties

McasDataConnectorDataTypes

Designação	Descrição	Valor
alertas	Alerta a conexão do tipo de dados.	DataConnectorDataTypeCommon
discoveryLogs	Conexão de tipo de dados de log de descoberta.	DataConnectorDataTypeCommon

McasDataConnectorPropriedades

Designação	Descrição	Valor
Tipos de dados	Os tipos de dados disponíveis para o conector.	McasDataConnectorDataTypes
inquilinoId	O ID do locatário ao qual se conectar e obter os dados.	string

MdatpDataConnector

Designação	Descrição	Valor
tipo	O tipo de conector de dados	'MicrosoftDefenderAdvancedThreatProtection' (obrigatório)
propriedades	Propriedades do conector de dados MDATP (Microsoft Defender Advanced Threat Protection).	MdatpDataConnectorProperties

MdatpDataConnectorProperties

Designação	Descrição	Valor
Tipos de dados	Os tipos de dados disponíveis para o conector.	AlertsDataTypeOfDataConnector
inquilinoId	O ID do locatário ao qual se conectar e obter os dados.	string