Data Connections - Get Data Connection

Služba:

Defender EASM (preview)

Verze rozhraní API:

2024-10-01-preview

Načtení datového připojení s daným názvem dataConnectionName

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dataConnectionName	path	True	string	Volající zadal jedinečný název prostředku.
endpoint	path	True	string (uri)	Koncový bod hostující požadovaný prostředek. Například https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	DataConnection: AzureDataExplorerDataConnection LogAnalyticsDataConnection	Požadavek byl úspěšný.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

DataConnections_GetDataConnection

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kó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"
}

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
AzureDataExplorerDataConnection
AzureDataExplorerDataConnectionProperties
DataConnectionContent	Typ dat, která bude datové připojení přenášet
DataConnectionFrequency	Rychlost, s jakou bude datové připojení přijímat aktualizace.
LogAnalyticsDataConnection
LogAnalyticsDataConnectionProperties

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

AzureDataExplorerDataConnection

Objekt

Name	Typ	Description
active	boolean	Indikátor toho, jestli je datové připojení aktivní.
content	DataConnectionContent	Typ dat, která bude datové připojení přenášet
createdDate	string (date-time)	Datum vytvoření datového připojení.
displayName	string	Název, který lze použít pro účely zobrazení.
frequency	DataConnectionFrequency	Rychlost, s jakou bude datové připojení přijímat aktualizace.
frequencyOffset	integer (int32)	Den aktualizace datového připojení. (1-7 týdně, 1-31 měsíčně)
id	string	To je obvykle stejné jako název, ale může se lišit pro různé modely.
inactiveMessage	string	Zpráva, která určuje podrobnosti o datovém připojení, pokud je neaktivní.
kind	string: azureDataExplorer	Diskriminující vlastnost dataConnection.
name	string	Volající zadal jedinečný název prostředku.
properties	AzureDataExplorerDataConnectionProperties	vlastnosti
updatedDate	string (date-time)	Datum poslední aktualizace datového připojení.
userUpdatedAt	string (date-time)	Datum poslední aktualizace datového připojení uživatelem.

AzureDataExplorerDataConnectionProperties

Objekt

Name	Typ	Description
clusterName	string	Název clusteru Azure Data Exploreru
databaseName	string	Název databáze Azure Data Exploreru
region	string	Oblast Azure Data Exploreru

DataConnectionContent

Výčet

Typ dat, která bude datové připojení přenášet

Hodnota	Description
assets
attackSurfaceInsights

DataConnectionFrequency

Výčet

Rychlost, s jakou bude datové připojení přijímat aktualizace.

Hodnota	Description
daily
weekly
monthly

LogAnalyticsDataConnection

Objekt

Name	Typ	Description
active	boolean	Indikátor toho, jestli je datové připojení aktivní.
content	DataConnectionContent	Typ dat, která bude datové připojení přenášet
createdDate	string (date-time)	Datum vytvoření datového připojení.
displayName	string	Název, který lze použít pro účely zobrazení.
frequency	DataConnectionFrequency	Rychlost, s jakou bude datové připojení přijímat aktualizace.
frequencyOffset	integer (int32)	Den aktualizace datového připojení. (1-7 týdně, 1-31 měsíčně)
id	string	To je obvykle stejné jako název, ale může se lišit pro různé modely.
inactiveMessage	string	Zpráva, která určuje podrobnosti o datovém připojení, pokud je neaktivní.
kind	string: logAnalytics	Diskriminující vlastnost dataConnection.
name	string	Volající zadal jedinečný název prostředku.
properties	LogAnalyticsDataConnectionProperties	vlastnosti
updatedDate	string (date-time)	Datum poslední aktualizace datového připojení.
userUpdatedAt	string (date-time)	Datum poslední aktualizace datového připojení uživatelem.

LogAnalyticsDataConnectionProperties

Objekt

Name	Typ	Description
apiKey	string	Klíč rozhraní API služby Log Analytics
workspaceId	string	ID pracovního prostoru služby Log Analytics