Metadata - Get

Riferimento

Service:: Log Analytics

API Version:: 2022-10-27_Preview

Ottiene informazioni sui metadati
Recuperare le informazioni sui metadati per l'area di lavoro, tra cui lo schema, le funzioni, le informazioni sull'area di lavoro, le categorie e così via.

GET https://api.loganalytics.io/v1/workspaces/{workspaceId}/metadata

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string	ID dell'area di lavoro. Questo è l'ID area di lavoro dal pannello Proprietà nel portale di Azure.

Risposte

Nome	Tipo	Descrizione
200 OK	metadataResults	OK. La chiamata API ha avuto esito positivo e il risultato dei metadati si trova nel payload della risposta
Other Status Codes	errorResponse	Oggetto risposta di errore.

Sicurezza

oauth2

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

metadataGet

Sample Request

HTTP

GET https://api.loganalytics.io/v1/workspaces/b438b4f6-912a-46d5-9cb1-b44069212abc/metadata

Sample Response

Status code:: 200

{
  "tables": [
    {
      "id": "ADAssessmentRecommendation",
      "name": "ADAssessmentRecommendation",
      "description": "Recommendations generated by AD assessments that are started through a scheduled task. When you schedule the assessment it runs by default every 7 days and upload the data into Azure Log Analytics",
      "timespanColumn": "TimeGenerated",
      "columns": [
        {
          "name": "SourceSystem",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "AssessmentId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "RecommendationId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Recommendation",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Description",
          "type": "string"
        },
        {
          "name": "RecommendationResult",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "TimeGenerated",
          "type": "datetime"
        },
        {
          "name": "FocusAreaId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "FocusArea",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "ActionAreaId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "ActionArea",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "RecommendationWeight",
          "type": "real"
        },
        {
          "name": "Computer",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "AffectedObjectType",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "AffectedObjectName",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Forest",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Domain",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "DomainController",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Technology",
          "type": "string"
        },
        {
          "name": "CustomData",
          "type": "string"
        },
        {
          "name": "TargetCount",
          "type": "int"
        },
        {
          "name": "IsRollup",
          "type": "bool",
          "isPreferredFacet": true
        },
        {
          "name": "IsCopied",
          "type": "bool",
          "isPreferredFacet": true
        },
        {
          "name": "RecommendationPeriod",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Type",
          "type": "string"
        },
        {
          "name": "_ResourceId",
          "type": "string"
        }
      ],
      "related": {
        "categories": [
          "workloads"
        ],
        "solutions": [
          "ADAssessment"
        ],
        "resourceTypes": [
          "microsoft.compute/virtualmachines"
        ]
      }
    },
    {
      "id": "custom_CL",
      "name": "custom_CL",
      "timespanColumn": "TimeGenerated",
      "columns": [
        {
          "name": "SourceSystem",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "ManagementGroupName",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "TimeGenerated",
          "type": "datetime",
          "isPreferredFacet": true
        },
        {
          "name": "Computer",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "RawData",
          "type": "string"
        },
        {
          "name": "Type",
          "type": "string"
        },
        {
          "name": "_ResourceId",
          "type": "string"
        }
      ],
      "related": {
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "solutions": [
    {
      "id": "ADAssessment",
      "name": "ADAssessment",
      "displayName": "Active Directory Health Check",
      "description": "Assess the risk and health of Active Directory environments.",
      "related": {
        "tables": [
          "ADAssessmentRecommendation"
        ],
        "functions": [
          "dwad"
        ],
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "functions": [
    {
      "id": "dwad",
      "name": "dwad",
      "displayName": "dasd",
      "body": "Heartbeat\r\n| where ResourceGroup != \"rg-SAP-DEVQA-005\" and ResourceGroup != \"rg-SAP-DEVQA-006\" and Computer contains \"\"\r\n| limit 500000\r\n| sort by Computer asc\r\n| distinct Computer\r\n",
      "related": {
        "solutions": [
          "ADAssessment"
        ],
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "resourceTypes": [
    {
      "id": "microsoft.compute/virtualmachines",
      "type": "Microsoft.Compute/VirtualMachines",
      "displayName": "Virtual machines",
      "related": {
        "tables": [
          "ADAssessmentRecommendation"
        ]
      }
    }
  ],
  "workspaces": [
    {
      "id": "b438b4f6-912a-46d5-9cb1-b44069212abc",
      "resourceId": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-IT",
      "name": "contosoretail-IT",
      "region": "eastus",
      "related": {
        "resourceTypes": [
          "microsoft.compute/virtualmachines"
        ],
        "tables": [
          "custom_CL"
        ],
        "solutions": [
          "ADAssessment"
        ],
        "functions": [
          "dwad"
        ]
      }
    }
  ],
  "categories": [
    {
      "id": "workloads",
      "displayName": "Workloads",
      "related": {
        "tables": [
          "ADAssessmentRecommendation",
          "ADReplicationResult",
          "SQLAssessmentRecommendation",
          "WorkloadMonitoringPerf"
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
Applications	Indicazione dell'autorizzazione per le app di Application Insights nella richiesta dei metadati.
Columns	Elenco di colonne definite nella tabella
errorDetail	Dettagli degli errori.
errorInfo	Codice e messaggio per un errore.
errorResponse	Dettagli errore.
metadataApplication	Un'applicazione di Application Insights.
metadataCategory	Categoria di metadati.
MetadataColumnDataType	Tipo di dati della colonna
metadataFunction	Funzione archiviata.
metadataPermissions	Informazioni sulle autorizzazioni.
metadataQuery	Query archiviata.
metadataResourceType	Tipo di risorsa in Azure.
metadataResults	Risposta ai metadati.
metadataSolution	Una soluzione di Log Analytics.
metadataTable	Tabella dati che fa parte di uno schema dell'area di lavoro.
metadataWorkspace	Un'area di lavoro Log Analytics.
Related	Elementi di metadati correlati per la categoria
Resources	Indicazione dell'autorizzazione per le risorse di Azure nella richiesta dei metadati.
Workspaces	Indicazione dell'autorizzazione per le aree di lavoro nella richiesta di metadati.

Applications

Indicazione dell'autorizzazione per le app di Application Insights nella richiesta dei metadati.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa nell'indicazione dell'autorizzazione.

Columns

Elenco di colonne definite nella tabella

Nome	Tipo	Descrizione
description	string	Descrizione della colonna
isPreferredFacet	boolean	Flag che indica che questa colonna è un facet preferito
name	string	Nome della colonna
source	object	un'indicazione dell'origine della colonna, usata solo quando più aree di lavoro hanno una definizione in conflitto per la colonna
type	MetadataColumnDataType	Tipo di dati della colonna

errorDetail

Dettagli degli errori.

Nome	Tipo	Descrizione
additionalProperties	object	Proprietà aggiuntive che possono essere fornite nell'oggetto dettagli errore
code	string	Codice dell'errore.
message	string	Messaggio di errore leggibile.
resources	string[]	Indica le risorse responsabili dell'errore.
target	string	Indica quale proprietà nella richiesta è responsabile dell'errore.
value	string	Indica quale valore in "target" è responsabile dell'errore.

errorInfo

Codice e messaggio per un errore.

Nome	Tipo	Descrizione
additionalProperties	object	Proprietà aggiuntive che possono essere fornite nell'oggetto informazioni sugli errori
code	string	Codice di errore leggibile dal computer.
details	errorDetail[]	dettagli dell'errore.
innererror	errorInfo	Codice e messaggio per un errore. Dettagli dell'errore interno, se esistenti.
message	string	Messaggio di errore leggibile.

errorResponse

Dettagli errore.

Nome	Tipo	Descrizione
error	errorInfo	Codice e messaggio per un errore. Dettagli dell'errore.

metadataApplication

Un'applicazione di Application Insights.

Nome	Tipo	Descrizione
id	string	ID dell'app Application Insights.
name	string	Nome dell'app Application Insights.
region	string	Area di Azure dell'app Application Insights.
related	Related	Elementi di metadati correlati per l'app Application Insights.
resourceId	string	ID risorsa ARM dell'app Application Insights.

metadataCategory

Categoria di metadati.

Nome	Tipo	Descrizione
description	string	Descrizione della categoria
displayName	string	Nome visualizzato della categoria
id	string	ID della categoria
related	Related	Elementi di metadati correlati per la categoria

MetadataColumnDataType

Tipo di dati della colonna

Nome	Tipo	Descrizione
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

metadataFunction

Funzione archiviata.

Nome	Tipo	Descrizione
body	string	Corpo KQL della funzione.
description	string	Descrizione della funzione.
displayName	string	Nome visualizzato della funzione.
id	string	ID della funzione.
name	string	Nome della funzione da usare nelle query.
parameters	string	Parametri/argomenti della funzione, se presenti.
properties	object	Proprietà della funzione.
related	Related	Elementi di metadati correlati per la funzione.
tags	object	Tag associati alla funzione.

metadataPermissions

Informazioni sulle autorizzazioni.

Nome	Tipo	Descrizione
applications	Applications[]	Indicazione dell'autorizzazione per le app di Application Insights nella richiesta di metadati.
resources	Resources[]	Indicazione dell'autorizzazione per le risorse di Azure nella richiesta di metadati.
workspaces	Workspaces[]	Indicazione delle autorizzazioni per le aree di lavoro nella richiesta di metadati.

metadataQuery

Query archiviata.

Nome	Tipo	Descrizione
body	string	Corpo KQL della query.
description	string	Descrizione della query.
displayName	string	Nome visualizzato della query.
id	string	ID della query.
labels	string[]	Etichette definite dall'utente associate alla query.
properties	object	Proprietà della query.
related	Related	Elementi di metadati correlati per la query.
tags	object	Tag associati alla query.

metadataResourceType

Tipo di risorsa in Azure.

Nome	Tipo	Descrizione
description	string	Descrizione del tipo di risorsa
displayName	string	Nome visualizzato del tipo di risorsa
id	string	ID del tipo di risorsa
labels	string[]	Etichette definite dall'utente del tipo di risorsa
properties	object	Proprietà del tipo di risorsa
related	Related	Elementi di metadati correlati per il tipo di risorsa
tags	object	Tag associati al tipo di risorsa
type	string	Tipo del tipo di risorsa

metadataResults

Risposta ai metadati.

Nome	Tipo	Descrizione
applications	metadataApplication[]	Elenco di app di Application Insights a cui si fa riferimento nella richiesta di metadati.
categories	metadataCategory[]	Elenco di categorie a cui viene fatto riferimento in questa risposta di metadati.
functions	metadataFunction[]	Elenco di funzioni archiviate nell'area di lavoro o introdotte da soluzioni e così via.
permissions	metadataPermissions[]	Elenco di regole di autorizzazione che hanno interessato la richiesta di metadati.
queries	metadataQuery[]	Elenco di query salvate archiviate nell'area di lavoro o introdotte da soluzioni, tipi di risorse e così via.
resourceTypes	metadataResourceType[]	Elenco di tipi di risorse a cui viene fatto riferimento in questa risposta di metadati.
resources	metadataResource[]	Elenco delle risorse di Azure a cui si fa riferimento nella richiesta di metadati.
solutions	metadataSolution[]	Elenco delle soluzioni di Log Analytics installate nell'area di lavoro.
tables	metadataTable[]	Elenco di tabelle e colonne che costituiscono lo schema dell'area di lavoro.
workspaces	metadataWorkspace[]	Elenco di aree di lavoro Log Analytics a cui si fa riferimento nella richiesta di metadati.

metadataSolution

Una soluzione di Log Analytics.

Nome	Tipo	Descrizione
description	string	Descrizione della soluzione Log Analytics
displayName	string	Nome visualizzato della soluzione Log Analytics
id	string	ID della soluzione Log Analytics
name	string	Nome della soluzione Log Analytics
properties	object	Proprietà della soluzione Log Analytics
related	Related	Elementi di metadati correlati per la soluzione Log Analytics
tags	object	Tag associati alla soluzione Log Analytics

metadataTable

Tabella dati che fa parte di uno schema dell'area di lavoro.

Nome	Tipo	Descrizione
columns	Columns[]	Elenco di colonne definite nella tabella
description	string	Descrizione della tabella
id	string	ID della tabella
labels	string[]	Etichette definite dall'utente della tabella
name	string	Nome della tabella
properties	object	Proprietà della tabella
related	Related	Elementi di metadati correlati per la tabella
tags	object	Tag associati alla tabella
timespanColumn	string	Colonna associata al parametro di query timepan per la tabella

metadataWorkspace

Un'area di lavoro Log Analytics.

Nome	Tipo	Descrizione
id	string	ID dell'area di lavoro Log Analytics.
name	string	Nome dell'area di lavoro Log Analytics.
region	string	Area di Azure dell'area di lavoro Log Analytics.
related	Related	Elementi di metadati correlati per l'area di lavoro Log Analytics.
resourceId	string	ID risorsa ARM dell'area di lavoro Log Analytics.

Elementi di metadati correlati per la categoria

Nome	Tipo	Descrizione
functions	string[]	Funzioni correlate alla categoria
queries	string[]	Query salvate correlate alla categoria
resourceTypes	string[]	Tipi di risorse correlati alla categoria
solutions	string[]	Soluzioni di Log Analytics correlate alla categoria
tables	string[]	Tabelle correlate alla categoria

Resources

Indicazione dell'autorizzazione per le risorse di Azure nella richiesta dei metadati.

Nome	Tipo	Descrizione
denyTables	string[]	Elenco delle tabelle che sono state negate l'accesso per l'ID risorsa.
resourceId	string	ID risorsa nell'indicazione dell'autorizzazione.

Workspaces

Indicazione dell'autorizzazione per le aree di lavoro nella richiesta di metadati.

Nome	Tipo	Descrizione
denyTables	string[]	Elenco delle tabelle che sono state negate l'accesso per l'ID risorsa.
resourceId	string	ID risorsa nell'indicazione dell'autorizzazione.

Condividi tramite

Metadata - Get

Parametri dell'URI

Risposte

Sicurezza

oauth2

Scopes

Esempio

metadataGet

Sample Request

Sample Response

Definizioni

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Resources

Workspaces

Risorse aggiuntive

Condividi tramite

Metadata - Get

Parametri dell'URI

Risposte

Sicurezza

oauth2

Scopes

Esempio

metadataGet

Sample Request

Sample Response

Definizioni

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Related

Resources

Workspaces

Risorse aggiuntive