Metadata - Get

Service:

Log Analytics

API Version:

2022-10-27_Preview

Metagegevensgegevens ophalen
Haal de metagegevensgegevens voor de werkruimte op, waaronder het schema, functies, werkruimtegegevens, categorieën, enzovoort.

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

URI-parameters

Name	In	Vereist	Type	Description
workspaceId	path	True	string	Id van de werkruimte. Dit is de werkruimte-id op de blade Eigenschappen in de Azure Portal.

Antwoorden

Name	Type	Description
200 OK	metadataResults	OK. De API-aanroep is geslaagd en het metagegevensresultaat is in de nettolading van het antwoord
Other Status Codes	errorResponse	Een foutreactieobject.

Beveiliging

oauth2

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name	Description
Applications	De machtigingsindicatie voor de Application Insights-apps in de metagegevensaanvraag.
Columns	De lijst met kolommen die in de tabel zijn gedefinieerd
errorDetail	Foutdetails.
errorInfo	De code en het bericht voor een fout.
errorResponse	Foutdetails.
metadataApplication	Een Application Insights-toepassing.
metadataCategory	Een metagegevenscategorie.
MetadataColumnDataType	Het gegevenstype van de kolom
metadataFunction	Een opgeslagen functie.
metadataPermissions	Machtigingsgegevens.
metadataQuery	Een opgeslagen query.
metadataResourceType	Een type resource in Azure.
metadataResults	Een antwoord met metagegevens.
metadataSolution	Een Log Analytics-oplossing.
metadataTable	Een gegevenstabel die deel uitmaakt van een werkruimteschema.
metadataWorkspace	Een Log Analytics-werkruimte.
Related	De gerelateerde metagegevensitems voor de categorie
Resources	De machtigingsindicatie voor de Azure-resources in de metagegevensaanvraag.
Workspaces	De machtigingsindicatie voor de werkruimten in de metagegevensaanvraag.

Applications

De machtigingsindicatie voor de Application Insights-apps in de metagegevensaanvraag.

Name	Type	Description
resourceId	string	De resource-id op de machtigingsindicatie.

Columns

De lijst met kolommen die in de tabel zijn gedefinieerd

Name	Type	Description
description	string	De beschrijving van de kolom
isPreferredFacet	boolean	Een vlag die aangeeft dat deze kolom een voorkeurs facet is
name	string	De naam van de kolom
source	object	een indicatie van de bron van de kolom, die alleen wordt gebruikt wanneer meerdere werkruimten een conflicterende definitie voor de kolom hebben
type	MetadataColumnDataType	Het gegevenstype van de kolom

errorDetail

Foutdetails.

Name	Type	Description
additionalProperties	object	Aanvullende eigenschappen die kunnen worden opgegeven voor het object met foutdetails
code	string	De code van de fout.
message	string	Een door mensen leesbaar foutbericht.
resources	string[]	Geeft resources aan die verantwoordelijk zijn voor de fout.
target	string	Geeft aan welke eigenschap in de aanvraag verantwoordelijk is voor de fout.
value	string	Geeft aan welke waarde in 'doel' verantwoordelijk is voor de fout.

errorInfo

De code en het bericht voor een fout.

Name	Type	Description
additionalProperties	object	Aanvullende eigenschappen die kunnen worden opgegeven voor het foutinformatieobject
code	string	Een machineleesbare foutcode.
details	errorDetail[]	details van de fout.
innererror	errorInfo	De code en het bericht voor een fout. Details van interne fout, indien aanwezig.
message	string	Een door mensen leesbaar foutbericht.

errorResponse

Foutdetails.

Name	Type	Description
error	errorInfo	De code en het bericht voor een fout. De foutdetails.

metadataApplication

Een Application Insights-toepassing.

Name	Type	Description
id	string	De id van de Application Insights-app.
name	string	De naam van de Application Insights-app.
region	string	De Azure-regio van de Application Insights-app.
related	Related	De gerelateerde metagegevensitems voor de Application Insights-app.
resourceId	string	De ARM-resource-id van de Application Insights-app.

metadataCategory

Een metagegevenscategorie.

Name	Type	Description
description	string	De beschrijving van de categorie
displayName	string	De weergavenaam van de categorie
id	string	De id van de categorie
related	Related	De gerelateerde metagegevensitems voor de categorie

MetadataColumnDataType

Het gegevenstype van de kolom

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

metadataFunction

Een opgeslagen functie.

Name	Type	Description
body	string	De KQL-hoofdtekst van de functie.
description	string	De beschrijving van de functie.
displayName	string	De weergavenaam van de functie.
id	string	De id van de functie.
name	string	De naam van de functie, die moet worden gebruikt in query's.
parameters	string	De parameters/argumenten van de functie, indien van toepassing.
properties	object	De eigenschappen van de functie.
related	Related	De gerelateerde metagegevensitems voor de functie.
tags	object	De tags die zijn gekoppeld aan de functie.

metadataPermissions

Machtigingsgegevens.

Name	Type	Description
applications	Applications[]	De machtigingsindicatie voor de Application Insights-apps in de metagegevensaanvraag.
resources	Resources[]	De machtigingsindicatie voor de Azure-resources in de metagegevensaanvraag.
workspaces	Workspaces[]	De machtigingsindicatie voor de werkruimten in de metagegevensaanvraag.

metadataQuery

Een opgeslagen query.

Name	Type	Description
body	string	De KQL-hoofdtekst van de query.
description	string	De beschrijving van de query.
displayName	string	De weergavenaam van de query.
id	string	De id van de query.
labels	string[]	De door de gebruiker gedefinieerde labels die zijn gekoppeld aan de query.
properties	object	De eigenschappen van de query.
related	Related	De gerelateerde metagegevensitems voor de query.
tags	object	De tags die zijn gekoppeld aan de query.

metadataResourceType

Een type resource in Azure.

Name	Type	Description
description	string	De beschrijving van het resourcetype
displayName	string	De weergavenaam van het resourcetype
id	string	De id van het resourcetype
labels	string[]	De door de gebruiker gedefinieerde labels van het resourcetype
properties	object	De eigenschappen van het resourcetype
related	Related	De gerelateerde metagegevensitems voor het resourcetype
tags	object	De tags die zijn gekoppeld aan het resourcetype
type	string	Het type resourcetype

metadataResults

Een antwoord met metagegevens.

Name	Type	Description
applications	metadataApplication[]	De lijst met Application Insights-apps waarnaar is verwezen in de metagegevensaanvraag.
categories	metadataCategory[]	De lijst met categorieën waarnaar wordt verwezen in dit metagegevensantwoord.
functions	metadataFunction[]	De lijst met functies die zijn opgeslagen in de werkruimte, of die zijn geïntroduceerd door oplossingen, enzovoort.
permissions	metadataPermissions[]	De lijst met machtigingsregels die van invloed zijn op de metagegevensaanvraag.
queries	metadataQuery[]	De lijst met opgeslagen query's die zijn opgeslagen in de werkruimte of geïntroduceerd door oplossingen, resourcetypen, enzovoort.
resourceTypes	metadataResourceType[]	De lijst met resourcetypen waarnaar wordt verwezen in dit metagegevensantwoord.
resources	metadataResource[]	De lijst met Azure-resources waarnaar is verwezen in de metagegevensaanvraag.
solutions	metadataSolution[]	De lijst met Log Analytics-oplossingen die in de werkruimte zijn geïnstalleerd.
tables	metadataTable[]	De lijst met tabellen en kolommen die het schema van de werkruimte vormen.
workspaces	metadataWorkspace[]	De lijst met Log Analytics-werkruimten waarnaar is verwezen in de metagegevensaanvraag.

metadataSolution

Een Log Analytics-oplossing.

Name	Type	Description
description	string	De beschrijving van de Log Analytics-oplossing
displayName	string	De weergavenaam van de Log Analytics-oplossing
id	string	De id van de Log Analytics-oplossing
name	string	De naam van de Log Analytics-oplossing
properties	object	De eigenschappen van de Log Analytics-oplossing
related	Related	De gerelateerde metagegevensitems voor de Log Analytics-oplossing
tags	object	De tags die zijn gekoppeld aan de Log Analytics-oplossing

metadataTable

Een gegevenstabel die deel uitmaakt van een werkruimteschema.

Name	Type	Description
columns	Columns[]	De lijst met kolommen die in de tabel zijn gedefinieerd
description	string	De beschrijving van de tabel
id	string	De id van de tabel
labels	string[]	De door de gebruiker gedefinieerde labels van de tabel
name	string	De naam van de tabel
properties	object	De eigenschappen van de tabel
related	Related	De gerelateerde metagegevensitems voor de tabel
tags	object	De tags die aan de tabel zijn gekoppeld
timespanColumn	string	De kolom die is gekoppeld aan de queryparameter voor de tijdspanne voor de tabel

metadataWorkspace

Een Log Analytics-werkruimte.

Name	Type	Description
id	string	De id van de Log Analytics-werkruimte.
name	string	De naam van de Log Analytics-werkruimte.
region	string	De Azure-regio van de Log Analytics-werkruimte.
related	Related	De gerelateerde metagegevensitems voor de Log Analytics-werkruimte.
resourceId	string	De ARM-resource-id van de Log Analytics-werkruimte.

Related

De gerelateerde metagegevensitems voor de categorie

Name	Type	Description
functions	string[]	De functies die betrekking hebben op de categorie
queries	string[]	De opgeslagen query's met betrekking tot de categorie
resourceTypes	string[]	De resourcetypen die betrekking hebben op de categorie
solutions	string[]	De Log Analytics-oplossingen met betrekking tot de categorie
tables	string[]	De tabellen die betrekking hebben op de categorie

Resources

De machtigingsindicatie voor de Azure-resources in de metagegevensaanvraag.

Name	Type	Description
denyTables	string[]	De lijst met tabellen die geen toegang hebben tot de resource-id.
resourceId	string	De resource-id op de machtigingsindicatie.

Workspaces

De machtigingsindicatie voor de werkruimten in de metagegevensaanvraag.

Name	Type	Description
denyTables	string[]	De lijst met tabellen die geen toegang hebben tot de resource-id.
resourceId	string	De resource-id op de machtigingsindicatie.