Compartir a través de

Data Connections - Get Data Connection

  • Referencia
Servicio:
Defender EASM (preview)
Versión de la API:
2024-10-01-preview

Recupere una conexión de datos con un dataConnectionName determinado.

GET {endpoint}/dataConnections/{dataConnectionName}?api-version=2024-10-01-preview

Parámetros de identificador URI

Nombre En Requerido Tipo Description
dataConnectionName
 path True

string

El autor de la llamada proporcionó un nombre único para el recurso.
endpoint
 path True

string

Punto de conexión que hospeda el recurso solicitado. Por ejemplo, https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Respuestas

Nombre Tipo Description
200 OK DataConnection:

La solicitud se ha realizado correctamente.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

OAuth2Auth

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

Ámbitos

Nombre Description
https://easm.defender.microsoft.com/.default

Ejemplos

DataConnections_GetDataConnection

Solicitud de ejemplo

GET {endpoint}/dataConnections/ThisisaDataConnection?api-version=2024-10-01-preview

Respuesta de muestra

status code:
200 
{
  "id": "ThisisaDataConnection",
  "name": "ThisisaDataConnection",
  "displayName": "ThisisaDataConnection",
  "kind": "logAnalytics",
  "frequency": "weekly",
  "frequencyOffset": 1,
  "properties": {
    "apiKey": "ThisisApiKey",
    "workspaceId": "ThisisWorkspaceId"
  },
  "createdDate": "2022-05-02T19:30:14.432+00:00",
  "updatedDate": "2022-05-02T19:30:14.432+00:00"
}

Definiciones

Nombre Description
Azure.Core.Foundations.Error

Objeto de error.
Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
AzureDataExplorerDataConnection
AzureDataExplorerDataConnectionProperties
DataConnectionContent

El tipo de datos que transferirá la conexión de datos
DataConnectionFrequency

Velocidad a la que la conexión de datos recibirá actualizaciones.
LogAnalyticsDataConnection
LogAnalyticsDataConnectionProperties

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.
details

Azure.Core.Foundations.Error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica que el objeto actual sobre el error.
message

string

Representación legible del error.
target

string

Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

Nombre Tipo Description
error

Azure.Core.Foundations.Error

Objeto de error.

Azure.Core.Foundations.InnerError

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.
innererror

Azure.Core.Foundations.InnerError

Error interno.

AzureDataExplorerDataConnection

Object
Nombre Tipo Description
active

boolean

Indicador de si la conexión de datos está activa.
content

DataConnectionContent

El tipo de datos que transferirá la conexión de datos
createdDate

string (date-time)

Fecha en que se creó la conexión de datos.
displayName

string

Nombre que se puede usar con fines de presentación.
frequency

DataConnectionFrequency

Velocidad a la que la conexión de datos recibirá actualizaciones.
frequencyOffset

integer (int32)

Día en el que se actualiza la conexión de datos. (1-7 para semanal, 1-31 para mensual)
id

string

Esto suele ser el mismo que el nombre, pero podría ser diferente para diferentes modelos.
inactiveMessage

string

Mensaje que especifica detalles sobre la conexión de datos si está inactivo.
kind string:

azureDataExplorer

Propiedad Discriminador para DataConnection.
name

string

El autor de la llamada proporcionó un nombre único para el recurso.
properties

AzureDataExplorerDataConnectionProperties

Propiedades
updatedDate

string (date-time)

Fecha en que se actualizó por última vez la conexión de datos.
userUpdatedAt

string (date-time)

Fecha en que el usuario actualizó por última vez la conexión de datos.

AzureDataExplorerDataConnectionProperties

Object
Nombre Tipo Description
clusterName

string

El nombre del clúster de Azure Data Explorer
databaseName

string

Nombre de la base de datos del Explorador de datos de Azure
region

string

La región del Explorador de datos de Azure

DataConnectionContent

Enumeración

El tipo de datos que transferirá la conexión de datos

Valor Description
assets
attackSurfaceInsights

DataConnectionFrequency

Enumeración

Velocidad a la que la conexión de datos recibirá actualizaciones.

Valor Description
daily
monthly
weekly

LogAnalyticsDataConnection

Object
Nombre Tipo Description
active

boolean

Indicador de si la conexión de datos está activa.
content

DataConnectionContent

El tipo de datos que transferirá la conexión de datos
createdDate

string (date-time)

Fecha en que se creó la conexión de datos.
displayName

string

Nombre que se puede usar con fines de presentación.
frequency

DataConnectionFrequency

Velocidad a la que la conexión de datos recibirá actualizaciones.
frequencyOffset

integer (int32)

Día en el que se actualiza la conexión de datos. (1-7 para semanal, 1-31 para mensual)
id

string

Esto suele ser el mismo que el nombre, pero podría ser diferente para diferentes modelos.
inactiveMessage

string

Mensaje que especifica detalles sobre la conexión de datos si está inactivo.
kind string:

logAnalytics

Propiedad Discriminador para DataConnection.
name

string

El autor de la llamada proporcionó un nombre único para el recurso.
properties

LogAnalyticsDataConnectionProperties

Propiedades
updatedDate

string (date-time)

Fecha en que se actualizó por última vez la conexión de datos.
userUpdatedAt

string (date-time)

Fecha en que el usuario actualizó por última vez la conexión de datos.

LogAnalyticsDataConnectionProperties

Object
Nombre Tipo Description
apiKey

string

clave de api de Log Analytics
workspaceId

string

identificador del área de trabajo de Log Analytics