Data Connectors - Connect

Serviço:

Sentinel

Versão da API:

2024-01-01-preview

Conecta um conector de dados.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}/connect?api-version=2024-01-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
dataConnectorId	path	True	string	ID do Conector
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
workspaceName	path	True	string	O nome do workspace. Padrão Regex: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
apiKey	string	A chave de API do servidor de auditoria.
authorizationCode	string	O código de autorização usado no fluxo de código OAuth 2.0 para emitir um token.
clientId	string	A ID do cliente do aplicativo OAuth 2.0.
clientSecret	string	O segredo do cliente do aplicativo OAuth 2.0.
dataCollectionEndpoint	string	Usado no conector de logs v2. Representa o ponto de extremidade de ingestão de coleta de dados no log analytics.
dataCollectionRuleImmutableId	string	Usado no conector de logs v2. A ID imutável da regra de coleta de dados, a regra define a transformação e o destino dos dados.
kind	ConnectAuthKind	O tipo de autenticação usado para sondar os dados
outputStream	string	Usado no conector de logs v2. O fluxo para o qual estamos enviando os dados, esse é o nome do streamDeclarations definido no DCR.
password	string	A senha do usuário no servidor de log de auditoria.
requestConfigUserInputValues	object[]
userName	string	O nome de usuário no servidor de log de auditoria.

Respostas

Nome	Tipo	Description
200 OK		OK, operação concluída com êxito
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8/connect?api-version=2024-01-01-preview

{
  "kind": "APIKey",
  "apiKey": "123456789",
  "requestConfigUserInputValues": [
    {
      "displayText": "Organization Name",
      "placeHolderName": "{{placeHolder1}}",
      "placeHolderValue": "somePlaceHolderValue",
      "requestObjectKey": "apiEndpoint"
    }
  ]
}

Resposta de exemplo

Código de status:

200

Connect an APIPolling V2 logs data connector

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8/connect?api-version=2024-01-01-preview

{
  "kind": "APIKey",
  "apiKey": "123456789",
  "dataCollectionEndpoint": "https://test.eastus.ingest.monitor.azure.com",
  "dataCollectionRuleImmutableId": "dcr-34adsj9o7d6f9de204478b9cgb43b631",
  "outputStream": "Custom-MyTableRawData",
  "requestConfigUserInputValues": [
    {
      "displayText": "Organization Name",
      "placeHolderName": "{{placeHolder1}}",
      "placeHolderValue": "somePlaceHolderValue",
      "requestObjectKey": "apiEndpoint"
    }
  ]
}

Resposta de exemplo

Código de status:

200

Definições

Nome	Description
CloudError	Estrutura de resposta de erro.
CloudErrorBody	Detalhes do erro.
ConnectAuthKind	O tipo de autenticação usado para sondar os dados
DataConnectorConnectBody	Representa o conector de dados sondagem de API sem código.

CloudError

Estrutura de resposta de erro.

Nome	Tipo	Description
error	CloudErrorBody	Dados do erro

CloudErrorBody

Detalhes do erro.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

ConnectAuthKind

O tipo de autenticação usado para sondar os dados

Nome	Tipo	Description
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Representa o conector de dados sondagem de API sem código.

Nome	Tipo	Description
apiKey	string	A chave de API do servidor de auditoria.
authorizationCode	string	O código de autorização usado no fluxo de código OAuth 2.0 para emitir um token.
clientId	string	A ID do cliente do aplicativo OAuth 2.0.
clientSecret	string	O segredo do cliente do aplicativo OAuth 2.0.
dataCollectionEndpoint	string	Usado no conector de logs v2. Representa o ponto de extremidade de ingestão de coleta de dados no log analytics.
dataCollectionRuleImmutableId	string	Usado no conector de logs v2. A ID imutável da regra de coleta de dados, a regra define a transformação e o destino dos dados.
kind	ConnectAuthKind	O tipo de autenticação usado para sondar os dados
outputStream	string	Usado no conector de logs v2. O fluxo para o qual estamos enviando os dados, esse é o nome do streamDeclarations definido no DCR.
password	string	A senha do usuário no servidor de log de auditoria.
requestConfigUserInputValues	object[]
userName	string	O nome de usuário no servidor de log de auditoria.