Metadata - Get

Referens

Tjänst:: Log Analytics

API-version:: 2022-10-27_Preview

Hämtar metadatainformation
Hämta metadatainformationen för arbetsytan, inklusive dess schema, funktioner, arbetsyteinformation, kategorier osv.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string	ID för arbetsytan. Det här är arbetsyte-ID från bladet Egenskaper i Azure Portal.

Svar

Name	Typ	Description
200 OK	metadataResults	OK. API-anropet lyckades och metadataresultatet finns i svarsnyttolasten
Other Status Codes	errorResponse	Ett felsvarsobjekt.

Säkerhet

oauth2

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

metadataGet

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Applications	Behörighetsindikatorn för Application Insights-appar i metadatabegäran.
Columns	Listan över kolumner som definierats i tabellen
errorDetail	Felinformation.
errorInfo	Koden och meddelandet för ett fel.
errorResponse	Felinformation.
metadataApplication	Ett Application Insights-program.
metadataCategory	En metadatakategori.
MetadataColumnDataType	Kolumnens datatyp
metadataFunction	En lagrad funktion.
metadataPermissions	Behörighetsinformation.
metadataQuery	En lagrad fråga.
metadataResourceType	En typ av resurs i Azure.
metadataResults	Ett metadatasvar.
metadataSolution	En Log Analytics-lösning.
metadataTable	En datatabell som ingår i ett arbetsyteschema.
metadataWorkspace	En Log Analytics-arbetsyta.
Related	Relaterade metadataobjekt för kategorin
Resources	Behörighetsindikatorn för Azure-resurserna i metadatabegäran.
Workspaces	Behörighetsindikatorn för arbetsytorna i metadatabegäran.

Applications

Behörighetsindikatorn för Application Insights-appar i metadatabegäran.

Name	Typ	Description
resourceId	string	Resurs-ID för behörighetsindikatorn.

Columns

Listan över kolumner som definierats i tabellen

Name	Typ	Description
description	string	Beskrivningen av kolumnen
isPreferredFacet	boolean	En flagga som anger att den här kolumnen är en prioriterad aspekt
name	string	Namnet på kolumnen
source	object	en indikation på kolumnens källa, som endast används när flera arbetsytor har motstridiga definitioner för kolumnen
type	MetadataColumnDataType	Datatypen för kolumnen

errorDetail

Felinformation.

Name	Typ	Description
additionalProperties	object	Ytterligare egenskaper som kan anges för felinformationsobjektet
code	string	Felkoden.
message	string	Ett felmeddelande som kan läsas av människor.
resources	string[]	Anger resurser som var ansvariga för felet.
target	string	Anger vilken egenskap i begäran som ansvarar för felet.
value	string	Anger vilket värde i "mål" som ansvarar för felet.

errorInfo

Koden och meddelandet för ett fel.

Name	Typ	Description
additionalProperties	object	Ytterligare egenskaper som kan anges för felinformationsobjektet
code	string	En felkod som kan läsas av datorn.
details	errorDetail[]	felinformation.
innererror	errorInfo	Koden och meddelandet för ett fel. Inre felinformation om de finns.
message	string	Ett mänskligt läsbart felmeddelande.

errorResponse

Felinformation.

Name	Typ	Description
error	errorInfo	Koden och meddelandet för ett fel. Felinformationen.

metadataApplication

Ett Application Insights-program.

Name	Typ	Description
id	string	ID för Application Insights-appen.
name	string	Namnet på Application Insights-appen.
region	string	Azure-regionen i Application Insights-appen.
related	Related	Relaterade metadataobjekt för Application Insights-appen.
resourceId	string	ARM-resurs-ID för Application Insights-appen.

metadataCategory

En metadatakategori.

Name	Typ	Description
description	string	Beskrivningen av kategorin
displayName	string	Visningsnamnet för kategorin
id	string	ID för kategorin
related	Related	Relaterade metadataobjekt för kategorin

MetadataColumnDataType

Kolumnens datatyp

Name	Typ	Description
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

metadataFunction

En lagrad funktion.

Name	Typ	Description
body	string	KQL-brödtexten i funktionen.
description	string	Beskrivningen av funktionen.
displayName	string	Visningsnamnet för funktionen.
id	string	ID för funktionen.
name	string	Namnet på funktionen som ska användas i frågor.
parameters	string	Parametrarna/argumenten för funktionen, om sådana finns.
properties	object	Funktionens egenskaper.
related	Related	Relaterade metadataobjekt för funktionen.
tags	object	Taggarna som är associerade med funktionen.

metadataPermissions

Behörighetsinformation.

Name	Typ	Description
applications	Applications[]	Behörighetsindikatorn för Application Insights-apparna på metadatabegäran.
resources	Resources[]	Behörighetsindikatorn för Azure-resurserna på metadatabegäran.
workspaces	Workspaces[]	Behörighetsindikatorn för arbetsytorna i metadatabegäran.

metadataQuery

En lagrad fråga.

Name	Typ	Description
body	string	KQL-brödtexten i frågan.
description	string	Beskrivningen av frågan.
displayName	string	Visningsnamnet för frågan.
id	string	Frågans ID.
labels	string[]	De användardefinierade etiketter som är associerade med frågan.
properties	object	Egenskaperna för frågan.
related	Related	Relaterade metadataobjekt för frågan.
tags	object	Taggarna som är associerade med frågan.

metadataResourceType

En typ av resurs i Azure.

Name	Typ	Description
description	string	Beskrivningen av resurstypen
displayName	string	Visningsnamnet för resurstypen
id	string	ID:t för resurstypen
labels	string[]	De användardefinierade etiketterna för resurstypen
properties	object	Egenskaperna för resurstypen
related	Related	Relaterade metadataobjekt för resurstypen
tags	object	Taggarna som är associerade med resurstypen
type	string	Typen av resurstyp

metadataResults

Ett metadatasvar.

Name	Typ	Description
applications	metadataApplication[]	Listan över Application Insights-appar som refererades till i metadatabegäran.
categories	metadataCategory[]	Listan över kategorier som refereras i det här metadatasvaret.
functions	metadataFunction[]	Listan över funktioner som lagras på arbetsytan, eller som introduceras av lösningar osv.
permissions	metadataPermissions[]	Listan över behörighetsregler som påverkade metadatabegäran.
queries	metadataQuery[]	Listan över sparade frågor som lagras på arbetsytan eller som introduceras av lösningar, resurstyper osv.
resourceTypes	metadataResourceType[]	Listan över resurstyper som refereras till i det här metadatasvaret.
resources	metadataResource[]	Listan över Azure-resurser som refererades till i metadatabegäran.
solutions	metadataSolution[]	Listan över Log Analytics-lösningar som är installerade på arbetsytan.
tables	metadataTable[]	Listan över tabeller och kolumner som utgör schemat för arbetsytan.
workspaces	metadataWorkspace[]	Listan över Log Analytics-arbetsytor som refererades till i metadatabegäran.

metadataSolution

En Log Analytics-lösning.

Name	Typ	Description
description	string	Beskrivningen av Log Analytics-lösningen
displayName	string	Visningsnamnet för Log Analytics-lösningen
id	string	ID för Log Analytics-lösningen
name	string	Namnet på Log Analytics-lösningen
properties	object	Egenskaperna för Log Analytics-lösningen
related	Related	Relaterade metadataobjekt för Log Analytics-lösningen
tags	object	Taggarna som är associerade med Log Analytics-lösningen

metadataTable

En datatabell som ingår i ett arbetsyteschema.

Name	Typ	Description
columns	Columns[]	Listan över kolumner som definierats i tabellen
description	string	Beskrivningen av tabellen
id	string	Tabellens ID
labels	string[]	Användardefinierade etiketter i tabellen
name	string	Namnet på tabellen
properties	object	Egenskaperna för tabellen
related	Related	Relaterade metadataobjekt för tabellen
tags	object	Taggarna som är associerade med tabellen
timespanColumn	string	Kolumnen som är associerad med frågeparametern för tidsintervall för tabellen

metadataWorkspace

En Log Analytics-arbetsyta.

Name	Typ	Description
id	string	ID för Log Analytics-arbetsytan.
name	string	Namnet på Log Analytics-arbetsytan.
region	string	Azure-regionen på Log Analytics-arbetsytan.
related	Related	Relaterade metadataobjekt för Log Analytics-arbetsytan.
resourceId	string	ARM-resurs-ID för Log Analytics-arbetsytan.

Relaterade metadataobjekt för kategorin

Name	Typ	Description
functions	string[]	Funktionerna som är relaterade till kategorin
queries	string[]	Sparade frågor relaterade till kategorin
resourceTypes	string[]	Resurstyperna som är relaterade till kategorin
solutions	string[]	Log Analytics-lösningarna som är relaterade till kategorin
tables	string[]	Tabellerna som är relaterade till kategorin

Resources

Behörighetsindikatorn för Azure-resurserna i metadatabegäran.

Name	Typ	Description
denyTables	string[]	Listan över tabeller som nekades åtkomst för resurs-ID:t.
resourceId	string	Resurs-ID för behörighetsindikatorn.

Workspaces

Behörighetsindikatorn för arbetsytorna i metadatabegäran.

Name	Typ	Description
denyTables	string[]	Listan över tabeller som nekades åtkomst för resurs-ID:t.
resourceId	string	Resurs-ID för behörighetsindikatorn.

Dela via

Metadata - Get

URI-parametrar

Svar

Säkerhet

oauth2

Omfattningar

Exempel

metadataGet

Exempelbegäran

Exempelsvar

Definitioner

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Resources

Workspaces

Ytterligare resurser

Dela via

Metadata - Get

URI-parametrar

Svar

Säkerhet

oauth2

Omfattningar

Exempel

metadataGet

Exempelbegäran

Exempelsvar

Definitioner

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Related

Resources

Workspaces

Ytterligare resurser