Data Connectors - Connect

Servicio:

Sentinel

Versión de la API:

2024-10-01-preview

Conecta un conector de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dataConnectorId	path	True	string	Identificador del conector
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string uuid	Identificador de la suscripción de destino. El valor debe ser un UUID.
workspaceName	path	True	string	Nombre del área de trabajo. Patrón de Regex: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
apiKey	string	Clave de API del servidor de auditoría.
authorizationCode	string	El código de autorización usado en el flujo de código de OAuth 2.0 para emitir un token.
clientId	string	Identificador de cliente de la aplicación OAuth 2.0.
clientSecret	string	Secreto de cliente de la aplicación OAuth 2.0.
dataCollectionEndpoint	string	Se usa en el conector de registros v2. Representa el punto de conexión de ingesta de recopilación de datos en Log Analytics.
dataCollectionRuleImmutableId	string	Se usa en el conector de registros v2. El identificador inmutable de la regla de recopilación de datos, la regla define la transformación y el destino de los datos.
kind	ConnectAuthKind	El tipo de autenticación usado para sondear los datos
outputStream	string	Se usa en el conector de registros v2. La secuencia a la que se envían los datos, este es el nombre de las streamDeclarations definidas en el DCR.
password	string	Contraseña de usuario en el servidor de registro de auditoría.
requestConfigUserInputValues	object[]
userName	string	Nombre de usuario en el servidor de registro de auditoría.

Respuestas

Nombre	Tipo	Description
200 OK		Correcto, operación completada correctamente
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Solicitud de ejemplo

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-10-01-preview

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

Respuesta de muestra

status code:

200

Connect an APIPolling V2 logs data connector

Solicitud de ejemplo

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-10-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"
    }
  ]
}

Respuesta de muestra

status code:

200

Definiciones

Nombre	Description
CloudError	Estructura de respuesta de error.
CloudErrorBody	Detalles del error.
ConnectAuthKind	El tipo de autenticación usado para sondear los datos
DataConnectorConnectBody	Representa el conector de datos de sondeo de API sin código.

CloudError

Estructura de respuesta de error.

Nombre	Tipo	Description
error	CloudErrorBody	Datos de error

CloudErrorBody

Detalles del error.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

ConnectAuthKind

El tipo de autenticación usado para sondear los datos

Nombre	Tipo	Description
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Representa el conector de datos de sondeo de API sin código.

Nombre	Tipo	Description
apiKey	string	Clave de API del servidor de auditoría.
authorizationCode	string	El código de autorización usado en el flujo de código de OAuth 2.0 para emitir un token.
clientId	string	Identificador de cliente de la aplicación OAuth 2.0.
clientSecret	string	Secreto de cliente de la aplicación OAuth 2.0.
dataCollectionEndpoint	string	Se usa en el conector de registros v2. Representa el punto de conexión de ingesta de recopilación de datos en Log Analytics.
dataCollectionRuleImmutableId	string	Se usa en el conector de registros v2. El identificador inmutable de la regla de recopilación de datos, la regla define la transformación y el destino de los datos.
kind	ConnectAuthKind	El tipo de autenticación usado para sondear los datos
outputStream	string	Se usa en el conector de registros v2. La secuencia a la que se envían los datos, este es el nombre de las streamDeclarations definidas en el DCR.
password	string	Contraseña de usuario en el servidor de registro de auditoría.
requestConfigUserInputValues	object[]
userName	string	Nombre de usuario en el servidor de registro de auditoría.