Data Connections - Get Data Connection

Szolgáltatás:

Defender EASM (preview)

API-verzió:

2024-10-01-preview

Adatkapcsolat lekérése egy adott dataConnectionName használatával.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
dataConnectionName	path	True	string	A hívó egyedi nevet adott az erőforrásnak.
endpoint	path	True	string	A kért erőforrást üzemeltető végpont. Például https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	DataConnection: AzureDataExplorerDataConnection LogAnalyticsDataConnection	A kérés sikeres volt.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

Biztonság

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

Példák

DataConnections_GetDataConnection

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
Azure.Core.Foundations.Error	A hibaobjektum.
Azure.Core.Foundations.ErrorResponse	Hibaadatokat tartalmazó válasz.
Azure.Core.Foundations.InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
AzureDataExplorerDataConnection
AzureDataExplorerDataConnectionProperties
DataConnectionContent	Az adatkapcsolat által átvinni kívánt adatok típusa
DataConnectionFrequency	Az adatkapcsolat frissítések fogadásának sebessége.
LogAnalyticsDataConnection
LogAnalyticsDataConnectionProperties

Azure.Core.Foundations.Error

Objektum

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Azure.Core.Foundations.Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	Azure.Core.Foundations.InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

Azure.Core.Foundations.ErrorResponse

Objektum

Hibaadatokat tartalmazó válasz.

Name	Típus	Description
error	Azure.Core.Foundations.Error	A hibaobjektum.

Azure.Core.Foundations.InnerError

Objektum

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	Azure.Core.Foundations.InnerError	Belső hiba.

AzureDataExplorerDataConnection

Objektum

Name	Típus	Description
active	boolean	Annak jelzése, hogy az adatkapcsolat aktív-e.
content	DataConnectionContent	Az adatkapcsolat által átvinni kívánt adatok típusa
createdDate	string (date-time)	Az adatkapcsolat létrehozásának dátuma.
displayName	string	A megjelenítendő név.
frequency	DataConnectionFrequency	Az adatkapcsolat frissítések fogadásának sebessége.
frequencyOffset	integer (int32)	Az adatkapcsolat frissítésének napja. (heti 1-7, havonta 1-31)
id	string	Ez általában megegyezik a névvel, de eltérő lehet a különböző modellek esetében.
inactiveMessage	string	Üzenet, amely az inaktív adatkapcsolat részleteit adja meg.
kind	string: azureDataExplorer	A DataConnection megkülönböztető tulajdonsága.
name	string	A hívó egyedi nevet adott az erőforrásnak.
properties	AzureDataExplorerDataConnectionProperties	kellékek
updatedDate	string (date-time)	Az adatkapcsolat utolsó frissítésének dátuma.
userUpdatedAt	string (date-time)	Az adatkapcsolat felhasználó általi legutóbbi frissítésének dátuma.

AzureDataExplorerDataConnectionProperties

Objektum

Name	Típus	Description
clusterName	string	Az Azure Data Explorer-fürt neve
databaseName	string	Az Azure Data Explorer adatbázisának neve
region	string	Az Azure Data Explorer régiója

DataConnectionContent

Enumerálás

Az adatkapcsolat által átvinni kívánt adatok típusa

Érték	Description
assets
attackSurfaceInsights

DataConnectionFrequency

Enumerálás

Az adatkapcsolat frissítések fogadásának sebessége.

Érték	Description
daily
monthly
weekly

LogAnalyticsDataConnection

Objektum

Name	Típus	Description
active	boolean	Annak jelzése, hogy az adatkapcsolat aktív-e.
content	DataConnectionContent	Az adatkapcsolat által átvinni kívánt adatok típusa
createdDate	string (date-time)	Az adatkapcsolat létrehozásának dátuma.
displayName	string	A megjelenítendő név.
frequency	DataConnectionFrequency	Az adatkapcsolat frissítések fogadásának sebessége.
frequencyOffset	integer (int32)	Az adatkapcsolat frissítésének napja. (heti 1-7, havonta 1-31)
id	string	Ez általában megegyezik a névvel, de eltérő lehet a különböző modellek esetében.
inactiveMessage	string	Üzenet, amely az inaktív adatkapcsolat részleteit adja meg.
kind	string: logAnalytics	A DataConnection megkülönböztető tulajdonsága.
name	string	A hívó egyedi nevet adott az erőforrásnak.
properties	LogAnalyticsDataConnectionProperties	kellékek
updatedDate	string (date-time)	Az adatkapcsolat utolsó frissítésének dátuma.
userUpdatedAt	string (date-time)	Az adatkapcsolat felhasználó általi legutóbbi frissítésének dátuma.

LogAnalyticsDataConnectionProperties

Objektum

Name	Típus	Description
apiKey	string	log analytics API-kulcs
workspaceId	string	Log Analytics-munkaterület azonosítója