Aracılığıyla paylaş


Metadata - Post

Meta veri bilgilerini alır
Çalışma alanının şeması, işlevleri, çalışma alanı bilgileri, kategorileri gibi meta veri bilgilerini alın.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
workspaceId
path True

string

Çalışma alanının kimliği. Bu, Azure portal Özellikler dikey penceresindeki Çalışma Alanı Kimliği'dir.

Yanıtlar

Name Tür Description
200 OK

metadataResults

Tamam ögesini seçin. API çağrısı başarılı oldu ve meta veri sonucu yanıt yükünde

Other Status Codes

errorResponse

Hata yanıtı nesnesi.

Güvenlik

oauth2

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

metadataPost

Örnek isteği

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

Örnek yanıt

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

Tanımlar

Name Description
Applications

Meta veri isteğinde Application Insights uygulamaları için izin göstergesi.

Columns

Tabloda tanımlanan sütunların listesi

errorDetail

Hata ayrıntıları.

errorInfo

Hatanın kodu ve iletisi.

errorResponse

Hata ayrıntıları.

metadataApplication

Application Insights uygulaması.

metadataCategory

Meta veri kategorisi.

MetadataColumnDataType

Sütunun veri türü

metadataFunction

Saklı bir işlev.

metadataPermissions

İzin bilgileri.

metadataQuery

Depolanan sorgu.

metadataResourceType

Azure'da bir kaynak türü.

metadataResults

Meta veri yanıtı.

metadataSolution

Log Analytics çözümü.

metadataTable

Çalışma alanı şemasında yer alan veri tablosu.

metadataWorkspace

Log Analytics çalışma alanı.

Related

Kategori için ilgili meta veri öğeleri

Resources

Meta veri isteğindeki Azure kaynakları için izin göstergesi.

Workspaces

Meta veri isteğindeki çalışma alanlarının izin göstergesi.

Applications

Meta veri isteğinde Application Insights uygulamaları için izin göstergesi.

Name Tür Description
resourceId

string

İzin göstergesindeki kaynak kimliği.

Columns

Tabloda tanımlanan sütunların listesi

Name Tür Description
description

string

Sütunun açıklaması

isPreferredFacet

boolean

Bu sütunun tercih edilen model olduğunu belirten bir bayrak

name

string

Sütunun adı

source

object

sütunun kaynağının göstergesi, yalnızca birden çok çalışma alanının sütun için çakışan tanımı olduğunda kullanılır

type

MetadataColumnDataType

Sütunun veri türü

errorDetail

Hata ayrıntıları.

Name Tür Description
additionalProperties

object

Hata ayrıntıları nesnesinde sağlanabilir ek özellikler

code

string

Hatanın kodu.

message

string

okunabilir bir hata iletisi.

resources

string[]

Hatadan sorumlu kaynakları gösterir.

target

string

İstekteki hangi özelliğin hatadan sorumlu olduğunu gösterir.

value

string

Hatadan 'target' içindeki hangi değerin sorumlu olduğunu gösterir.

errorInfo

Hatanın kodu ve iletisi.

Name Tür Description
additionalProperties

object

Hata bilgisi nesnesinde sağlanabilir ek özellikler

code

string

Makine tarafından okunabilir bir hata kodu.

details

errorDetail[]

hata ayrıntıları.

innererror

errorInfo

Hatanın kodu ve iletisi.
İç hata ayrıntıları varsa.

message

string

okunabilir bir hata iletisi.

errorResponse

Hata ayrıntıları.

Name Tür Description
error

errorInfo

Hatanın kodu ve iletisi.
Hata ayrıntıları.

metadataApplication

Application Insights uygulaması.

Name Tür Description
id

string

Application Insights uygulamasının kimliği.

name

string

Application Insights uygulamasının adı.

region

string

Application Insights uygulamasının Azure bölgesi.

related

Related

Application Insights uygulaması için ilgili meta veri öğeleri.

resourceId

string

Application Insights uygulamasının ARM kaynak kimliği.

metadataCategory

Meta veri kategorisi.

Name Tür Description
description

string

Kategorinin açıklaması

displayName

string

Kategorinin görünen adı

id

string

Kategorinin kimliği

related

Related

Kategori için ilgili meta veri öğeleri

MetadataColumnDataType

Sütunun veri türü

Name Tür Description
bool

string

datetime

string

decimal

string

dynamic

string

guid

string

int

string

long

string

real

string

string

string

timespan

string

metadataFunction

Saklı bir işlev.

Name Tür Description
body

string

İşlevin KQL gövdesi.

description

string

İşlevin açıklaması.

displayName

string

İşlevin görünen adı.

id

string

İşlevin kimliği.

name

string

Sorgularda kullanılacak işlevin adı.

parameters

string

Varsa, işlevin parametreleri/bağımsız değişkenleri.

properties

object

İşlevin özellikleri.

related

Related

İşlev için ilgili meta veri öğeleri.

tags

object

İşlevle ilişkili etiketler.

metadataPermissions

İzin bilgileri.

Name Tür Description
applications

Applications[]

Meta veri isteğinde Application Insights uygulamaları için izin göstergesi.

resources

Resources[]

Meta veri isteğindeki Azure kaynakları için izin göstergesi.

workspaces

Workspaces[]

Meta veri isteğindeki çalışma alanlarının izin göstergesi.

metadataQuery

Depolanan sorgu.

Name Tür Description
body

string

Sorgunun KQL gövdesi.

description

string

Sorgunun açıklaması.

displayName

string

Sorgunun görünen adı.

id

string

Sorgunun kimliği.

labels

string[]

Sorguyla ilişkili kullanıcı tanımlı etiketler.

properties

object

Sorgunun özellikleri.

related

Related

Sorgu için ilgili meta veri öğeleri.

tags

object

Sorguyla ilişkili etiketler.

metadataResourceType

Azure'da bir kaynak türü.

Name Tür Description
description

string

Kaynak türünün açıklaması

displayName

string

Kaynak türünün görünen adı

id

string

Kaynak türünün kimliği

labels

string[]

Kaynak türünün kullanıcı tanımlı etiketleri

properties

object

Kaynak türünün özellikleri

related

Related

Kaynak türü için ilgili meta veri öğeleri

tags

object

Kaynak türüyle ilişkili etiketler

type

string

Kaynak türünün türü

metadataResults

Meta veri yanıtı.

Name Tür Description
applications

metadataApplication[]

Meta veri isteğinde başvuruda bulunılan Application Insights uygulamalarının listesi.

categories

metadataCategory[]

Bu meta veri yanıtında başvuruda bulunan kategorilerin listesi.

functions

metadataFunction[]

Çalışma alanında depolanan veya çözümler tarafından tanıtılan işlevlerin listesi.

permissions

metadataPermissions[]

Meta veri isteğini etkileyen izin kurallarının listesi.

queries

metadataQuery[]

Çalışma alanında depolanan veya çözümler, kaynak türleri vb. tarafından tanıtılan kaydedilmiş sorguların listesi.

resourceTypes

metadataResourceType[]

Bu meta veri yanıtında başvuruda bulunan kaynak türlerinin listesi.

resources

metadataResource[]

Meta veri isteğinde başvuruda bulunılan Azure kaynaklarının listesi.

solutions

metadataSolution[]

Çalışma alanında yüklü Log Analytics çözümlerinin listesi.

tables

metadataTable[]

Çalışma alanının şemasını oluşturan tablo ve sütunların listesi.

workspaces

metadataWorkspace[]

Meta veri isteğinde başvuruda bulunılan Log Analytics çalışma alanlarının listesi.

metadataSolution

Log Analytics çözümü.

Name Tür Description
description

string

Log Analytics çözümünün açıklaması

displayName

string

Log Analytics çözümünün görünen adı

id

string

Log Analytics çözümünün kimliği

name

string

Log Analytics çözümünün adı

properties

object

Log Analytics çözümünün özellikleri

related

Related

Log Analytics çözümü için ilgili meta veri öğeleri

tags

object

Log Analytics çözümüyle ilişkili etiketler

metadataTable

Çalışma alanı şemasında yer alan veri tablosu.

Name Tür Description
columns

Columns[]

Tabloda tanımlanan sütunların listesi

description

string

Tablonun açıklaması

id

string

Tablonun kimliği

labels

string[]

Tablonun kullanıcı tanımlı etiketleri

name

string

Tablonun adı

properties

object

Tablonun özellikleri

related

Related

Tablo için ilgili meta veri öğeleri

tags

object

Tabloyla ilişkilendirilmiş etiketler

timespanColumn

string

Tablonun zaman aralığı sorgu parametresiyle ilişkili sütun

metadataWorkspace

Log Analytics çalışma alanı.

Name Tür Description
id

string

Log Analytics çalışma alanının kimliği.

name

string

Log Analytics çalışma alanının adı.

region

string

Log Analytics çalışma alanının Azure bölgesi.

related

Related

Log Analytics çalışma alanı için ilgili meta veri öğeleri.

resourceId

string

Log Analytics çalışma alanının ARM kaynak kimliği.

Kategori için ilgili meta veri öğeleri

Name Tür Description
functions

string[]

Kategoriyle ilgili işlevler

queries

string[]

Kategoriyle ilgili kaydedilen sorgular

resourceTypes

string[]

Kategoriyle ilgili kaynak türleri

solutions

string[]

Kategoriyle ilgili Log Analytics çözümleri

tables

string[]

Kategoriyle ilgili tablolar

Resources

Meta veri isteğindeki Azure kaynakları için izin göstergesi.

Name Tür Description
denyTables

string[]

Kaynak kimliği için erişimi reddedilen tabloların listesi.

resourceId

string

İzin göstergesindeki kaynak kimliği.

Workspaces

Meta veri isteğindeki çalışma alanlarının izin göstergesi.

Name Tür Description
denyTables

string[]

Kaynak kimliği için erişimi reddedilen tabloların listesi.

resourceId

string

İzin göstergesindeki kaynak kimliği.