Data Connectors - Connect

Serviço:

Sentinel

Versão da API:

2024-01-01-preview

Liga 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 do URI

Name	Em	Necessário	Tipo	Description
dataConnectorId	path	True	string	ID do Conector
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
workspaceName	path	True	string	O nome da área de trabalho. 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 utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
apiKey	string	A chave de API do servidor de auditoria.
authorizationCode	string	O código de autorização utilizado no fluxo de código OAuth 2.0 para emitir um token.
clientId	string	O ID de cliente da aplicação OAuth 2.0.
clientSecret	string	O segredo do cliente da aplicação OAuth 2.0.
dataCollectionEndpoint	string	Utilizado no conector de registos v2. Representa o ponto final de ingestão de dados no Log Analytics.
dataCollectionRuleImmutableId	string	Utilizado no conector de registos v2. O ID imutável da regra de recolha de dados, a regra define a transformação e o destino dos dados.
kind	ConnectAuthKind	O tipo de autenticação utilizado para consultar os dados
outputStream	string	Utilizado no conector de registos v2. O fluxo para o qual estamos a enviar os dados é o nome das StreamDeclarations definidas no DCR.
password	string	A palavra-passe de utilizador no servidor de registo de auditoria.
requestConfigUserInputValues	object[]
userName	string	O nome de utilizador no servidor de registo de auditoria.

Respostas

Name	Tipo	Description
200 OK		OK, Operação concluída com êxito
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Pedido de amostra

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 da amostra

Código de estado:

200

Connect an APIPolling V2 logs data connector

Pedido de amostra

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 da amostra

Código de estado:

200

Definições

Name	Description
CloudError	Estrutura de resposta a erros.
CloudErrorBody	Detalhes do erro.
ConnectAuthKind	O tipo de autenticação utilizado para consultar os dados
DataConnectorConnectBody	Representa o conector de dados de Consulta de API Sem Código.

CloudError

Estrutura de resposta a erros.

Name	Tipo	Description
error	CloudErrorBody	Dados de erro

CloudErrorBody

Detalhes do erro.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.

ConnectAuthKind

O tipo de autenticação utilizado para consultar os dados

Name	Tipo	Description
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Representa o conector de dados de Consulta de API Sem Código.

Name	Tipo	Description
apiKey	string	A chave de API do servidor de auditoria.
authorizationCode	string	O código de autorização utilizado no fluxo de código OAuth 2.0 para emitir um token.
clientId	string	O ID de cliente da aplicação OAuth 2.0.
clientSecret	string	O segredo do cliente da aplicação OAuth 2.0.
dataCollectionEndpoint	string	Utilizado no conector de registos v2. Representa o ponto final de ingestão de dados no Log Analytics.
dataCollectionRuleImmutableId	string	Utilizado no conector de registos v2. O ID imutável da regra de recolha de dados, a regra define a transformação e o destino dos dados.
kind	ConnectAuthKind	O tipo de autenticação utilizado para consultar os dados
outputStream	string	Utilizado no conector de registos v2. O fluxo para o qual estamos a enviar os dados é o nome das StreamDeclarations definidas no DCR.
password	string	A palavra-passe de utilizador no servidor de registo de auditoria.
requestConfigUserInputValues	object[]
userName	string	O nome de utilizador no servidor de registo de auditoria.