Metadata - Get

Referenz

Dienst:: Log Analytics

API-Version:: 2022-10-27_Preview

Ruft Metadateninformationen ab.
Abrufen der Metadateninformationen für den Arbeitsbereich, einschließlich schema, Funktionen, Arbeitsbereichsinformationen, Kategorien usw.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string	ID des Arbeitsbereichs. Dies ist die Arbeitsbereichs-ID vom Blatt "Eigenschaften" im Azure-Portal.

Antworten

Name	Typ	Beschreibung
200 OK	metadataResults	OKAY. Der API-Aufruf war erfolgreich, und das Metadatenergebnis befindet sich in der Antwortnutzlast.
Other Status Codes	errorResponse	Ein Fehlerantwortobjekt.

Sicherheit

oauth2

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

metadataGet

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
Applications	Die Berechtigungsanzeige für die Application Insights-Apps in der Metadatenanforderung.
Columns	Die Liste der spalten, die in der Tabelle definiert sind
errorDetail	Fehlerdetails.
errorInfo	Der Code und die Meldung für einen Fehler.
errorResponse	Fehlerdetails.
metadataApplication	Eine Application Insights-Anwendung.
metadataCategory	Eine Metadatenkategorie.
MetadataColumnDataType	Der Datentyp der Spalte
metadataFunction	Eine gespeicherte Funktion.
metadataPermissions	Berechtigungsinformationen.
metadataQuery	Eine gespeicherte Abfrage.
metadataResourceType	Ein Ressourcentyp in Azure.
metadataResults	Eine Metadatenantwort.
metadataSolution	Eine Log Analytics-Lösung.
metadataTable	Eine Datentabelle, die an einem Arbeitsbereichsschema teilnimmt.
metadataWorkspace	Einen Log Analytics-Arbeitsbereich
Related	Die zugehörigen Metadatenelemente für die Kategorie
Resources	Die Berechtigungsangabe für die Azure-Ressourcen in der Metadatenanforderung.
Workspaces	Die Berechtigungsanzeige für die Arbeitsbereiche in der Metadatenanforderung.

Applications

Objekt

Die Berechtigungsanzeige für die Application Insights-Apps in der Metadatenanforderung.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID für die Berechtigungsanzeige.

Columns

Objekt

Die Liste der spalten, die in der Tabelle definiert sind

Name	Typ	Beschreibung
description	string	Die Beschreibung der Spalte
isPreferredFacet	boolean	Ein Kennzeichen, das angibt, dass diese Spalte ein bevorzugtes Facet ist
name	string	Der Name der Spalte
source	object	Ein Hinweis auf die Quelle der Spalte, die nur verwendet wird, wenn mehrere Arbeitsbereiche eine widersprüchliche Definition für die Spalte aufweisen
type	MetadataColumnDataType	Der Datentyp der Spalte

errorDetail

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
additionalProperties	object	Zusätzliche Eigenschaften, die für das Fehlerdetails-Objekt bereitgestellt werden können
code	string	Der Code des Fehlers.
message	string	Eine lesbare Fehlermeldung.
resources	string[]	Gibt Ressourcen an, die für den Fehler verantwortlich waren.
target	string	Gibt an, welche Eigenschaft in der Anforderung für den Fehler verantwortlich ist.
value	string	Gibt an, welcher Wert in "target" für den Fehler verantwortlich ist.

errorInfo

Objekt

Der Code und die Meldung für einen Fehler.

Name	Typ	Beschreibung
additionalProperties	object	Zusätzliche Eigenschaften, die für das Fehlerinformationsobjekt bereitgestellt werden können
code	string	Ein computerlesbarer Fehlercode.
details	errorDetail[]	Fehlerdetails.
innererror	errorInfo	Der Code und die Meldung für einen Fehler. Innere Fehlerdetails, falls vorhanden.
message	string	Eine lesbare Fehlermeldung.

errorResponse

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
error	errorInfo	Der Code und die Meldung für einen Fehler. Die Fehlerdetails.

metadataApplication

Objekt

Eine Application Insights-Anwendung.

Name	Typ	Beschreibung
id	string	Die ID der Application Insights-App.
name	string	Der Name der Application Insights-App.
region	string	Die Azure-Region der Application Insights-App.
related	Related	Die zugehörigen Metadatenelemente für die Application Insights-App.
resourceId	string	Die ARM-Ressourcen-ID der Application Insights-App.

metadataCategory

Objekt

Eine Metadatenkategorie.

Name	Typ	Beschreibung
description	string	Die Beschreibung der Kategorie
displayName	string	Der Anzeigename der Kategorie
id	string	Die ID der Kategorie
related	Related	Die zugehörigen Metadatenelemente für die Kategorie

MetadataColumnDataType

Enumeration

Der Datentyp der Spalte

Wert	Beschreibung
bool
datetime
decimal
dynamic
guid
int
long
real
string
timespan

metadataFunction

Objekt

Eine gespeicherte Funktion.

Name	Typ	Beschreibung
body	string	Der KQL-Textkörper der Funktion.
description	string	Die Beschreibung der Funktion.
displayName	string	Der Anzeigename der Funktion.
id	string	Die ID der Funktion.
name	string	Der Name der Funktion, die in Abfragen verwendet werden soll.
parameters	string	Die Parameter/Argumente der Funktion, falls vorhanden.
properties	object	Die Eigenschaften der Funktion.
related	Related	Die zugehörigen Metadatenelemente für die Funktion.
tags	object	Die tags, die der Funktion zugeordnet sind.

metadataPermissions

Objekt

Berechtigungsinformationen.

Name	Typ	Beschreibung
applications	Applications[]	Die Berechtigungsanzeige für die Application Insights-Apps in der Metadatenanforderung.
resources	Resources[]	Die Berechtigungsangabe für die Azure-Ressourcen in der Metadatenanforderung.
workspaces	Workspaces[]	Die Berechtigungsanzeige für die Arbeitsbereiche in der Metadatenanforderung.

metadataQuery

Objekt

Eine gespeicherte Abfrage.

Name	Typ	Beschreibung
body	string	Der KQL-Textkörper der Abfrage.
description	string	Die Beschreibung der Abfrage.
displayName	string	Der Anzeigename der Abfrage.
id	string	Die ID der Abfrage.
labels	string[]	Die benutzerdefinierten Bezeichnungen, die der Abfrage zugeordnet sind.
properties	object	Die Eigenschaften der Abfrage.
related	Related	Die zugehörigen Metadatenelemente für die Abfrage.
tags	object	Die mit der Abfrage verknüpften Tags.

metadataResourceType

Objekt

Ein Ressourcentyp in Azure.

Name	Typ	Beschreibung
description	string	Die Beschreibung des Ressourcentyps
displayName	string	Der Anzeigename des Ressourcentyps
id	string	Die ID des Ressourcentyps
labels	string[]	Die benutzerdefinierten Bezeichnungen des Ressourcentyps
properties	object	Die Eigenschaften des Ressourcentyps
related	Related	Die zugehörigen Metadatenelemente für den Ressourcentyp
tags	object	Die Tags, die dem Ressourcentyp zugeordnet sind
type	string	Der Typ des Ressourcentyps

metadataResults

Objekt

Eine Metadatenantwort.

Name	Typ	Beschreibung
applications	metadataApplication[]	Die Liste der Application Insights-Apps, auf die in der Metadatenanforderung verwiesen wurde.
categories	metadataCategory[]	Die Liste der Kategorien, auf die in dieser Metadatenantwort verwiesen wird.
functions	metadataFunction[]	Die Liste der funktionen, die im Arbeitsbereich gespeichert sind oder von Lösungen usw. eingeführt wurden.
permissions	metadataPermissions[]	Die Liste der Berechtigungsregeln, die sich auf die Metadatenanforderung auswirkten.
queries	metadataQuery[]	Die Liste der gespeicherten Abfragen, die im Arbeitsbereich gespeichert sind oder von Lösungen, Ressourcentypen usw. eingeführt wurden.
resourceTypes	metadataResourceType[]	Die Liste der Ressourcentypen, auf die in dieser Metadatenantwort verwiesen wird.
resources	metadataResource[]	Die Liste der Azure-Ressourcen, auf die in der Metadatenanforderung verwiesen wurde.
solutions	metadataSolution[]	Die Liste der im Arbeitsbereich installierten Log Analytics-Lösungen.
tables	metadataTable[]	Die Liste der Tabellen und Spalten, die das Schema des Arbeitsbereichs umfassen.
workspaces	metadataWorkspace[]	Die Liste der Log Analytics-Arbeitsbereiche, auf die in der Metadatenanforderung verwiesen wurde.

metadataSolution

Objekt

Eine Log Analytics-Lösung.

Name	Typ	Beschreibung
description	string	Die Beschreibung der Log Analytics-Lösung
displayName	string	Der Anzeigename der Log Analytics-Lösung
id	string	Die ID der Log Analytics-Lösung
name	string	Der Name der Log Analytics-Lösung
properties	object	Die Eigenschaften der Log Analytics-Lösung
related	Related	Die zugehörigen Metadatenelemente für die Log Analytics-Lösung
tags	object	Die Tags, die der Log Analytics-Lösung zugeordnet sind

metadataTable

Objekt

Eine Datentabelle, die an einem Arbeitsbereichsschema teilnimmt.

Name	Typ	Beschreibung
columns	Columns[]	Die Liste der spalten, die in der Tabelle definiert sind
description	string	Die Beschreibung der Tabelle
id	string	Die ID der Tabelle
labels	string[]	Die benutzerdefinierten Bezeichnungen der Tabelle
name	string	Der Name der Tabelle.
properties	object	Die Eigenschaften der Tabelle
related	Related	Die zugehörigen Metadatenelemente für die Tabelle
tags	object	Die tags, die der Tabelle zugeordnet sind
timespanColumn	string	Die Spalte, die dem Zeitbereich-Abfrageparameter für die Tabelle zugeordnet ist

metadataWorkspace

Objekt

Einen Log Analytics-Arbeitsbereich

Name	Typ	Beschreibung
id	string	Die ID des Log Analytics-Arbeitsbereichs.
name	string	Der Name des Log Analytics-Arbeitsbereichs.
region	string	Die Azure-Region des Log Analytics-Arbeitsbereichs.
related	Related	Die zugehörigen Metadatenelemente für den Log Analytics-Arbeitsbereich.
resourceId	string	Die ARM-Ressourcen-ID des Log Analytics-Arbeitsbereichs.

Objekt

Die zugehörigen Metadatenelemente für die Kategorie

Name	Typ	Beschreibung
functions	string[]	Die Funktionen im Zusammenhang mit der Kategorie
queries	string[]	Die gespeicherten Abfragen im Zusammenhang mit der Kategorie
resourceTypes	string[]	Die Ressourcentypen im Zusammenhang mit der Kategorie
solutions	string[]	Die Log Analytics-Lösungen im Zusammenhang mit der Kategorie
tables	string[]	Die Tabellen im Zusammenhang mit der Kategorie

Resources

Objekt

Die Berechtigungsangabe für die Azure-Ressourcen in der Metadatenanforderung.

Name	Typ	Beschreibung
denyTables	string[]	Die Liste der Tabellen, die den Zugriff auf die Ressourcen-ID verweigert haben.
resourceId	string	Die Ressourcen-ID für die Berechtigungsanzeige.

Workspaces

Objekt

Die Berechtigungsanzeige für die Arbeitsbereiche in der Metadatenanforderung.

Name	Typ	Beschreibung
denyTables	string[]	Die Liste der Tabellen, die den Zugriff auf die Ressourcen-ID verweigert haben.
resourceId	string	Die Ressourcen-ID für die Berechtigungsanzeige.

Freigeben über

Metadata - Get

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

metadataGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Resources

Workspaces

Zusätzliche Ressourcen

Freigeben über

Metadata - Get

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

metadataGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Related

Resources

Workspaces

Zusätzliche Ressourcen