Data Connections - Validate Data Connection

Servizio:

Defender EASM (preview)

Versione API:

2024-10-01-preview

Convalidare una connessione dati con un determinato dataConnectionName.

POST {endpoint}/dataConnections:validate?api-version=2024-10-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint che ospita la risorsa richiesta. Ad esempio, https://{area}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
AzureDataExplorerDataConnectionData
LogAnalyticsDataConnectionData

AzureDataExplorerDataConnectionData

Nome	Necessario	Tipo	Descrizione
kind	True	string: azureDataExplorer	Proprietà discriminatoria per DataConnectionData.
properties	True	AzureDataExplorerDataConnectionProperties	proprietà
content		DataConnectionContent	Tipo di dati che verrà trasferita dalla connessione dati.
frequency		DataConnectionFrequency	Frequenza con cui la connessione dati riceverà gli aggiornamenti.
frequencyOffset		integer (int32)	Giorno in cui aggiornare la connessione dati. (1-7 per settimanale, 1-31 per mensile)
name		string	Nome della connessione dati

LogAnalyticsDataConnectionData

Nome	Necessario	Tipo	Descrizione
kind	True	string: logAnalytics	Proprietà discriminatoria per DataConnectionData.
properties	True	LogAnalyticsDataConnectionProperties	proprietà
content		DataConnectionContent	Tipo di dati che verrà trasferita dalla connessione dati.
frequency		DataConnectionFrequency	Frequenza con cui la connessione dati riceverà gli aggiornamenti.
frequencyOffset		integer (int32)	Giorno in cui aggiornare la connessione dati. (1-7 per settimanale, 1-31 per mensile)
name		string	Nome della connessione dati

Risposte

Nome	Tipo	Descrizione
200 OK	ValidateResult	La richiesta ha avuto esito positivo.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://easm.defender.microsoft.com/.default

Esempio

DataConnections_ValidateDataConnection

Esempio di richiesta

HTTP

POST {endpoint}/dataConnections:validate?api-version=2024-10-01-preview

{
  "kind": "logAnalytics",
  "properties": {
    "apiKey": "ThisisApiKey",
    "workspaceId": "ThisisWorkspaceId"
  },
  "frequency": "weekly",
  "frequencyOffset": 1,
  "name": "ThisisaDataConnection"
}

Risposta di esempio

Codice di stato:

200

{
  "error": null
}

Definizioni

Nome	Descrizione
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
AzureDataExplorerDataConnectionData
AzureDataExplorerDataConnectionProperties
DataConnectionContent	Il tipo di dati che verrà trasferita dalla connessione dati
DataConnectionFrequency	Frequenza con cui la connessione dati riceverà gli aggiornamenti.
ErrorDetail	Si tratta dell'oggetto errore di primo livello il cui codice corrisponde all'intestazione di risposta x-ms-error-code.
InnerError	Si tratta di un oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
LogAnalyticsDataConnectionData
LogAnalyticsDataConnectionProperties
ValidateResult	Convalidare il risultato per convalidare gli endpoint dell'azione

Azure.Core.Foundations.Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Object

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

AzureDataExplorerDataConnectionData

Object

Nome	Tipo	Descrizione
content	DataConnectionContent	Tipo di dati che verrà trasferita dalla connessione dati.
frequency	DataConnectionFrequency	Frequenza con cui la connessione dati riceverà gli aggiornamenti.
frequencyOffset	integer (int32)	Giorno in cui aggiornare la connessione dati. (1-7 per settimanale, 1-31 per mensile)
kind	string: azureDataExplorer	Proprietà discriminatoria per DataConnectionData.
name	string	Nome della connessione dati
properties	AzureDataExplorerDataConnectionProperties	proprietà

AzureDataExplorerDataConnectionProperties

Object

Nome	Tipo	Descrizione
clusterName	string	Nome del cluster di Esplora dati di Azure
databaseName	string	Nome del database di Esplora dati di Azure
region	string	Area di Esplora dati di Azure

DataConnectionContent

Enumerazione

Il tipo di dati che verrà trasferita dalla connessione dati

Valore	Descrizione
assets
attackSurfaceInsights

DataConnectionFrequency

Enumerazione

Frequenza con cui la connessione dati riceverà gli aggiornamenti.

Valore	Descrizione
daily
monthly
weekly

ErrorDetail

Object

Si tratta dell'oggetto errore di primo livello il cui codice corrisponde all'intestazione di risposta x-ms-error-code.

Nome	Tipo	Descrizione
code	string	Si tratta di un set definito dal server di codici di errore.
details	ErrorDetail[]	Si tratta di una matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerError	Si tratta di un oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Si tratta di una rappresentazione leggibile dell'errore.
target	string	Questa è la destinazione dell'errore.

InnerError

Object

Si tratta di un oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

Nome	Tipo	Descrizione
code	string	Si tratta di un codice di errore più specifico di quello fornito dall'errore che lo contiene.
value		Si tratta di un campo aggiuntivo che rappresenta il valore che ha causato l'errore per facilitare il debug.

LogAnalyticsDataConnectionData

Object

Nome	Tipo	Descrizione
content	DataConnectionContent	Tipo di dati che verrà trasferita dalla connessione dati.
frequency	DataConnectionFrequency	Frequenza con cui la connessione dati riceverà gli aggiornamenti.
frequencyOffset	integer (int32)	Giorno in cui aggiornare la connessione dati. (1-7 per settimanale, 1-31 per mensile)
kind	string: logAnalytics	Proprietà discriminatoria per DataConnectionData.
name	string	Nome della connessione dati
properties	LogAnalyticsDataConnectionProperties	proprietà

LogAnalyticsDataConnectionProperties

Object

Nome	Tipo	Descrizione
apiKey	string	Chiave API di Log Analytics
workspaceId	string	ID area di lavoro Log Analytics

ValidateResult

Object

Convalidare il risultato per convalidare gli endpoint dell'azione

Nome	Tipo	Descrizione
error	ErrorDetail	Si tratta dell'oggetto errore di primo livello il cui codice corrisponde all'intestazione di risposta x-ms-error-code.