Sdílet prostřednictvím


Metadata - Post

Získá informace o metadatech.
Načtěte informace o metadatech pracovního prostoru, včetně jeho schématu, funkcí, informací o pracovním prostoru, kategorií atd.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
workspaceId
path True

string

ID pracovního prostoru. Toto je ID pracovního prostoru z okna Vlastnosti v Azure Portal.

Odpovědi

Name Typ Description
200 OK

metadataResults

OK. Volání rozhraní API bylo úspěšné a výsledek metadat je v datové části odpovědi.

Other Status Codes

errorResponse

Objekt odpovědi na chybu.

Zabezpečení

oauth2

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

metadataPost

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
Applications

Označení oprávnění pro aplikace Application Insights v požadavku na metadata.

Columns

Seznam sloupců definovaných v tabulce

errorDetail

Podrobnosti o chybě.

errorInfo

Kód a zpráva o chybě.

errorResponse

Podrobnosti o chybě.

metadataApplication

Aplikace Application Insights.

metadataCategory

Kategorie metadat.

MetadataColumnDataType

Datový typ sloupce

metadataFunction

Uložená funkce.

metadataPermissions

Informace o oprávněních.

metadataQuery

Uložený dotaz.

metadataResourceType

Typ prostředku v Azure.

metadataResults

Odpověď metadat.

metadataSolution

Řešení Log Analytics.

metadataTable

Tabulka dat, která se účastní schématu pracovního prostoru.

metadataWorkspace

Pracovní prostor služby Log Analytics.

Related

Související položky metadat pro kategorii

Resources

Označení oprávnění pro prostředky Azure v požadavku na metadata.

Workspaces

Označení oprávnění pro pracovní prostory v požadavku na metadata.

Applications

Označení oprávnění pro aplikace Application Insights v požadavku na metadata.

Name Typ Description
resourceId

string

ID prostředku v indikaci oprávnění.

Columns

Seznam sloupců definovaných v tabulce

Name Typ Description
description

string

Popis sloupce

isPreferredFacet

boolean

Příznak označující tento sloupec jako upřednostňovanou omezující vlastnost

name

string

Název sloupce

source

object

údaj o zdroji sloupce, který se používá pouze v případě, že více pracovních prostorů má konfliktní definici sloupce

type

MetadataColumnDataType

Datový typ sloupce

errorDetail

Podrobnosti o chybě.

Name Typ Description
additionalProperties

object

Další vlastnosti, které lze zadat u objektu podrobností o chybě

code

string

Kód chyby.

message

string

Chybová zpráva čitelná pro člověka.

resources

string[]

Označuje prostředky, které byly zodpovědné za chybu.

target

string

Určuje, která vlastnost v požadavku je za chybu zodpovědná.

value

string

Určuje, která hodnota v cílovém objektu je zodpovědná za chybu.

errorInfo

Kód a zpráva o chybě.

Name Typ Description
additionalProperties

object

Další vlastnosti, které je možné zadat u objektu informací o chybě

code

string

Strojově čitelný kód chyby.

details

errorDetail[]

podrobnosti o chybě.

innererror

errorInfo

Kód a zpráva o chybě.
Podrobnosti o vnitřní chybě, pokud existují.

message

string

Chybová zpráva čitelná pro člověka.

errorResponse

Podrobnosti o chybě.

Name Typ Description
error

errorInfo

Kód a zpráva o chybě.
Podrobnosti o chybě.

metadataApplication

Aplikace Application Insights.

Name Typ Description
id

string

ID aplikace Application Insights.

name

string

Název aplikace Application Insights.

region

string

Oblast Azure aplikace Application Insights.

related

Related

Související položky metadat pro aplikaci Application Insights.

resourceId

string

ID prostředku ARM aplikace Application Insights.

metadataCategory

Kategorie metadat.

Name Typ Description
description

string

Popis kategorie

displayName

string

Zobrazovaný název kategorie

id

string

ID kategorie

related

Related

Související položky metadat pro kategorii

MetadataColumnDataType

Datový typ sloupce

Name Typ Description
bool

string

datetime

string

decimal

string

dynamic

string

guid

string

int

string

long

string

real

string

string

string

timespan

string

metadataFunction

Uložená funkce.

Name Typ Description
body

string

Tělo funkce KQL

description

string

Popis funkce

displayName

string

Zobrazovaný název funkce

id

string

ID funkce.

name

string

Název funkce, která se má použít v dotazech.

parameters

string

Parametry a argumenty funkce, pokud jsou k dispozici.

properties

object

Vlastnosti funkce

related

Related

Související položky metadat pro funkci.

tags

object

Značky přidružené k funkci

metadataPermissions

Informace o oprávněních.

Name Typ Description
applications

Applications[]

Označení oprávnění pro aplikace Application Insights v požadavku na metadata.

resources

Resources[]

Označení oprávnění pro prostředky Azure v požadavku na metadata.

workspaces

Workspaces[]

Označení oprávnění pro pracovní prostory v požadavku na metadata.

metadataQuery

Uložený dotaz.

Name Typ Description
body

string

Tělo KQL dotazu.

description

string

Popis dotazu

displayName

string

Zobrazovaný název dotazu

id

string

ID dotazu.

labels

string[]

Uživatelem definované popisky přidružené k dotazu.

properties

object

Vlastnosti dotazu.

related

Related

Související položky metadat pro dotaz.

tags

object

Značky přidružené k dotazu.

metadataResourceType

Typ prostředku v Azure.

Name Typ Description
description

string

Popis typu prostředku

displayName

string

Zobrazovaný název typu prostředku

id

string

ID typu prostředku

labels

string[]

Uživatelem definované popisky typu prostředku

properties

object

Vlastnosti typu prostředku

related

Related

Související položky metadat pro typ prostředku

tags

object

Značky přidružené k typu prostředku

type

string

Typ prostředku

metadataResults

Odpověď metadat.

Name Typ Description
applications

metadataApplication[]

Seznam aplikací Application Insights, na které se odkazuje v požadavku na metadata.

categories

metadataCategory[]

Seznam kategorií, na které se odkazuje v této odpovědi metadat.

functions

metadataFunction[]

Seznam funkcí uložených v pracovním prostoru nebo zavedených řešeními atd.

permissions

metadataPermissions[]

Seznam pravidel oprávnění, která ovlivnila požadavek na metadata.

queries

metadataQuery[]

Seznam dotazů uložených v pracovním prostoru nebo zavedených řešeními, typy prostředků atd.

resourceTypes

metadataResourceType[]

Seznam typů prostředků, na které se odkazuje v této odpovědi na metadata.

resources

metadataResource[]

Seznam prostředků Azure, na které se odkazuje v požadavku na metadata.

solutions

metadataSolution[]

Seznam řešení Log Analytics nainstalovaných v pracovním prostoru

tables

metadataTable[]

Seznam tabulek a sloupců, které tvoří schéma pracovního prostoru.

workspaces

metadataWorkspace[]

Seznam pracovních prostorů služby Log Analytics, na které se odkazuje v požadavku na metadata.

metadataSolution

Řešení Log Analytics.

Name Typ Description
description

string

Popis řešení Log Analytics

displayName

string

Zobrazovaný název řešení Log Analytics

id

string

ID řešení Log Analytics

name

string

Název řešení Log Analytics

properties

object

Vlastnosti řešení Log Analytics

related

Related

Související položky metadat pro řešení Log Analytics

tags

object

Značky přidružené k řešení Log Analytics

metadataTable

Tabulka dat, která se účastní schématu pracovního prostoru.

Name Typ Description
columns

Columns[]

Seznam sloupců definovaných v tabulce

description

string

Popis tabulky

id

string

ID tabulky

labels

string[]

Popisky tabulky definované uživatelem

name

string

Název tabulky

properties

object

Vlastnosti tabulky

related

Related

Související položky metadat pro tabulku

tags

object

Značky přidružené k tabulce

timespanColumn

string

Sloupec přidružený k parametru dotazu časového rozsahu pro tabulku

metadataWorkspace

Pracovní prostor služby Log Analytics.

Name Typ Description
id

string

ID pracovního prostoru služby Log Analytics.

name

string

Název pracovního prostoru služby Log Analytics.

region

string

Oblast Azure pracovního prostoru služby Log Analytics.

related

Related

Související položky metadat pro pracovní prostor služby Log Analytics.

resourceId

string

ID prostředku ARM pracovního prostoru služby Log Analytics.

Související položky metadat pro kategorii

Name Typ Description
functions

string[]

Funkce související s kategorií

queries

string[]

Uložené dotazy související s kategorií

resourceTypes

string[]

Typy prostředků související s kategorií

solutions

string[]

Řešení Log Analytics související s kategorií

tables

string[]

Tabulky související s kategorií

Resources

Označení oprávnění pro prostředky Azure v požadavku na metadata.

Name Typ Description
denyTables

string[]

Seznam tabulek, kterým byl odepřen přístup pro ID prostředku.

resourceId

string

ID prostředku v indikaci oprávnění.

Workspaces

Označení oprávnění pro pracovní prostory v požadavku na metadata.

Name Typ Description
denyTables

string[]

Seznam tabulek, kterým byl odepřen přístup pro ID prostředku.

resourceId

string

ID prostředku v indikaci oprávnění.