Metadata - Get

Odwołanie

Usługa:: Log Analytics

Wersja interfejsu API:: 2022-10-27_Preview

Pobiera informacje o metadanych
Pobierz informacje o metadanych obszaru roboczego, w tym jego schemat, funkcje, informacje o obszarze roboczym, kategorie itp.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string	Identyfikator obszaru roboczego. Jest to identyfikator obszaru roboczego z bloku Właściwości w Azure Portal.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	metadataResults	OK. Wywołanie interfejsu API powiodło się, a wynik metadanych znajduje się w ładunku odpowiedzi
Other Status Codes	errorResponse	Obiekt odpowiedzi o błędzie.

Zabezpieczenia

oauth2

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

metadataGet

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
Applications	Wskazanie uprawnień dla aplikacji usługi Application Insights w żądaniu metadanych.
Columns	Lista kolumn zdefiniowanych w tabeli
errorDetail	Szczegóły błędu.
errorInfo	Kod i komunikat dotyczący błędu.
errorResponse	Szczegóły błędu.
metadataApplication	Aplikacja usługi Application Insights.
metadataCategory	Kategoria metadanych.
MetadataColumnDataType	Typ danych kolumny
metadataFunction	Przechowywana funkcja.
metadataPermissions	Informacje o uprawnieniach.
metadataQuery	Przechowywane zapytanie.
metadataResourceType	Typ zasobu na platformie Azure.
metadataResults	Odpowiedź na metadane.
metadataSolution	Rozwiązanie usługi Log Analytics.
metadataTable	Tabela danych, która bierze udział w schemacie obszaru roboczego.
metadataWorkspace	Obszar roboczy usługi Log Analytics.
Related	Powiązane elementy metadanych dla kategorii
Resources	Wskazanie uprawnień dla zasobów platformy Azure w żądaniu metadanych.
Workspaces	Wskazanie uprawnień dla obszarów roboczych w żądaniu metadanych.

Applications

Wskazanie uprawnień dla aplikacji usługi Application Insights w żądaniu metadanych.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu ze wskazaniem uprawnień.

Columns

Lista kolumn zdefiniowanych w tabeli

Nazwa	Typ	Opis
description	string	Opis kolumny
isPreferredFacet	boolean	Flaga wskazująca, że ta kolumna jest preferowanym aspektem
name	string	Nazwa kolumny
source	object	wskazanie źródła kolumny, używane tylko wtedy, gdy wiele obszarów roboczych ma definicję powodującą konflikt dla kolumny
type	MetadataColumnDataType	Typ danych kolumny

errorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalProperties	object	Dodatkowe właściwości, które można podać w obiekcie szczegółów błędu
code	string	Kod błędu.
message	string	Komunikat o błędzie czytelny dla człowieka.
resources	string[]	Wskazuje zasoby, które były odpowiedzialne za błąd.
target	string	Wskazuje, która właściwość w żądaniu jest odpowiedzialna za błąd.
value	string	Wskazuje, która wartość w obiekcie docelowym jest odpowiedzialna za błąd.

errorInfo

Kod i komunikat dotyczący błędu.

Nazwa	Typ	Opis
additionalProperties	object	Dodatkowe właściwości, które można podać w obiekcie informacji o błędzie
code	string	Kod błędu z możliwością odczytu maszyny.
details	errorDetail[]	szczegóły błędu.
innererror	errorInfo	Kod i komunikat dotyczący błędu. Szczegóły błędu wewnętrznego, jeśli istnieją.
message	string	Komunikat o błędzie czytelny dla człowieka.

errorResponse

Szczegóły błędu.

Nazwa	Typ	Opis
error	errorInfo	Kod i komunikat dotyczący błędu. Szczegóły błędu.

metadataApplication

Aplikacja usługi Application Insights.

Nazwa	Typ	Opis
id	string	Identyfikator aplikacji Usługi Application Insights.
name	string	Nazwa aplikacji Usługi Application Insights.
region	string	Region platformy Azure aplikacji Application Insights.
related	Related	Powiązane elementy metadanych dla aplikacji Usługi Application Insights.
resourceId	string	Identyfikator zasobu usługi ARM aplikacji Application Insights.

metadataCategory

Kategoria metadanych.

Nazwa	Typ	Opis
description	string	Opis kategorii
displayName	string	Nazwa wyświetlana kategorii
id	string	Identyfikator kategorii
related	Related	Powiązane elementy metadanych dla kategorii

MetadataColumnDataType

Typ danych kolumny

Nazwa	Typ	Opis
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

metadataFunction

Przechowywana funkcja.

Nazwa	Typ	Opis
body	string	Treść funkcji KQL.
description	string	Opis funkcji.
displayName	string	Nazwa wyświetlana funkcji.
id	string	Identyfikator funkcji.
name	string	Nazwa funkcji, która ma być używana w zapytaniach.
parameters	string	Parametry/argumenty funkcji, jeśli istnieją.
properties	object	Właściwości funkcji.
related	Related	Powiązane elementy metadanych dla funkcji.
tags	object	Tagi skojarzone z funkcją.

metadataPermissions

Informacje o uprawnieniach.

Nazwa	Typ	Opis
applications	Applications[]	Wskazanie uprawnień dla aplikacji usługi Application Insights w żądaniu metadanych.
resources	Resources[]	Wskazanie uprawnień dla zasobów platformy Azure w żądaniu metadanych.
workspaces	Workspaces[]	Wskazanie uprawnień dla obszarów roboczych w żądaniu metadanych.

metadataQuery

Przechowywane zapytanie.

Nazwa	Typ	Opis
body	string	Treść KQL zapytania.
description	string	Opis zapytania.
displayName	string	Nazwa wyświetlana zapytania.
id	string	Identyfikator zapytania.
labels	string[]	Etykiety zdefiniowane przez użytkownika skojarzone z zapytaniem.
properties	object	Właściwości zapytania.
related	Related	Powiązane elementy metadanych dla zapytania.
tags	object	Tagi skojarzone z zapytaniem.

metadataResourceType

Typ zasobu na platformie Azure.

Nazwa	Typ	Opis
description	string	Opis typu zasobu
displayName	string	Nazwa wyświetlana typu zasobu
id	string	Identyfikator typu zasobu
labels	string[]	Etykiety zdefiniowane przez użytkownika typu zasobu
properties	object	Właściwości typu zasobu
related	Related	Powiązane elementy metadanych dla typu zasobu
tags	object	Tagi skojarzone z typem zasobu
type	string	Typ zasobu

metadataResults

Odpowiedź na metadane.

Nazwa	Typ	Opis
applications	metadataApplication[]	Lista aplikacji usługi Application Insights, do których odwołuje się żądanie metadanych.
categories	metadataCategory[]	Lista kategorii, do których odwołuje się ta odpowiedź metadanych.
functions	metadataFunction[]	Lista funkcji przechowywanych w obszarze roboczym lub wprowadzonych przez rozwiązania itp.
permissions	metadataPermissions[]	Lista reguł uprawnień, które miały wpływ na żądanie metadanych.
queries	metadataQuery[]	Lista zapisanych zapytań przechowywanych w obszarze roboczym lub wprowadzonych przez rozwiązania, typy zasobów itp.
resourceTypes	metadataResourceType[]	Lista typów zasobów, do których odwołuje się ta odpowiedź metadanych.
resources	metadataResource[]	Lista zasobów platformy Azure, do których odwołuje się żądanie metadanych.
solutions	metadataSolution[]	Lista rozwiązań usługi Log Analytics zainstalowanych w obszarze roboczym.
tables	metadataTable[]	Lista tabel i kolumn składających się na schemat obszaru roboczego.
workspaces	metadataWorkspace[]	Lista obszarów roboczych usługi Log Analytics, do których odwołuje się żądanie metadanych.

metadataSolution

Rozwiązanie usługi Log Analytics.

Nazwa	Typ	Opis
description	string	Opis rozwiązania usługi Log Analytics
displayName	string	Nazwa wyświetlana rozwiązania usługi Log Analytics
id	string	Identyfikator rozwiązania usługi Log Analytics
name	string	Nazwa rozwiązania usługi Log Analytics
properties	object	Właściwości rozwiązania usługi Log Analytics
related	Related	Powiązane elementy metadanych dla rozwiązania Usługi Log Analytics
tags	object	Tagi skojarzone z rozwiązaniem usługi Log Analytics

metadataTable

Tabela danych, która bierze udział w schemacie obszaru roboczego.

Nazwa	Typ	Opis
columns	Columns[]	Lista kolumn zdefiniowanych w tabeli
description	string	Opis tabeli
id	string	Identyfikator tabeli
labels	string[]	Etykiety zdefiniowane przez użytkownika w tabeli
name	string	Nazwa tabeli
properties	object	Właściwości tabeli
related	Related	Powiązane elementy metadanych dla tabeli
tags	object	Tagi skojarzone z tabelą
timespanColumn	string	Kolumna skojarzona z parametrem zapytania przedziału czasu dla tabeli

metadataWorkspace

Obszar roboczy usługi Log Analytics.

Nazwa	Typ	Opis
id	string	Identyfikator obszaru roboczego usługi Log Analytics.
name	string	Nazwa obszaru roboczego usługi Log Analytics.
region	string	Region platformy Azure obszaru roboczego usługi Log Analytics.
related	Related	Powiązane elementy metadanych dla obszaru roboczego usługi Log Analytics.
resourceId	string	Identyfikator zasobu usługi ARM obszaru roboczego usługi Log Analytics.

Powiązane elementy metadanych dla kategorii

Nazwa	Typ	Opis
functions	string[]	Funkcje związane z kategorią
queries	string[]	Zapisane zapytania związane z kategorią
resourceTypes	string[]	Typy zasobów powiązane z kategorią
solutions	string[]	Rozwiązania usługi Log Analytics powiązane z kategorią
tables	string[]	Tabele powiązane z kategorią

Resources

Wskazanie uprawnień dla zasobów platformy Azure w żądaniu metadanych.

Nazwa	Typ	Opis
denyTables	string[]	Lista tabel, do których odmówiono dostępu dla identyfikatora zasobu.
resourceId	string	Identyfikator zasobu ze wskazaniem uprawnień.

Workspaces

Wskazanie uprawnień dla obszarów roboczych w żądaniu metadanych.

Nazwa	Typ	Opis
denyTables	string[]	Lista tabel, do których odmówiono dostępu dla identyfikatora zasobu.
resourceId	string	Identyfikator zasobu ze wskazaniem uprawnień.

Udostępnij za pośrednictwem

Metadata - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

metadataGet

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Resources

Workspaces

Dodatkowe zasoby

Udostępnij za pośrednictwem

Metadata - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

metadataGet

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Related

Resources

Workspaces

Dodatkowe zasoby