你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Schema - Get

获取给定工作区的架构。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/schema?api-version=2020-08-01

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

workspaceName
path True

string

工作区的名称。

正则表达式模式: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

SearchGetSchemaResponse

确定响应定义。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

WorkspacesGetSchema

示例请求

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/atlantisdemo/schema?api-version=2020-08-01

示例响应

{
  "metadata": {
    "schema": {
      "name": "CloudOps",
      "version": 2
    },
    "resultType": "schema",
    "requestTime": 28
  },
  "value": [
    {
      "name": "TenantId",
      "displayName": "TenantId",
      "type": "Guid",
      "indexed": true,
      "stored": false,
      "facet": false,
      "ownerType": [
        "Alert",
        "AzureActivity",
        "AzureAudit",
        "AzureMetrics",
        "ComputerGroup",
        "ETWEvent",
        "Event",
        "ExtraHopDBLogin",
        "ExtraHopDBTransaction",
        "ExtraHopDNSResponse",
        "ExtraHopFTPResponse",
        "ExtraHopHTTPTransaction",
        "ExtraHopSMTPMessage",
        "ExtraHopSYNScanDetect",
        "ExtraHopTCPOpen",
        "Heartbeat",
        "Operation",
        "Perf",
        "ReservedAzureCommonFields",
        "ReservedCommonFields",
        "ServiceFabricOperationalEvent",
        "ServiceFabricReliableActorEvent",
        "ServiceFabricReliableServiceEvent",
        "Syslog",
        "Usage",
        "W3CIISLog"
      ]
    }
  ]
}

定义

名称 说明
CoreSummary

搜索的核心摘要。

SearchGetSchemaResponse

获取架构操作响应。

SearchMetadata

搜索结果的元数据。

SearchMetadataSchema

用于搜索的架构元数据。

SearchSchemaValue

架构结果的值对象。

SearchSort

用于搜索的排序参数。

SearchSortEnum

搜索的排序顺序。

CoreSummary

搜索的核心摘要。

名称 类型 说明
numberOfDocuments

integer

核心摘要的文档数。

status

string

核心摘要的状态。

SearchGetSchemaResponse

获取架构操作响应。

名称 类型 说明
metadata

SearchMetadata

搜索结果中的元数据。

value

SearchSchemaValue[]

结果值的数组。

SearchMetadata

搜索结果的元数据。

名称 类型 说明
aggregatedGroupingFields

string

聚合分组字段。

aggregatedValueField

string

聚合值字段。

coreSummaries

CoreSummary[]

核心摘要。

eTag

string

搜索结果的 ETag。

id

string

搜索结果请求的 ID。

lastUpdated

string

最近一次更新时间。

max

integer

结果集中返回的所有聚合的最大值。

requestId

string

搜索的请求 ID。

requestTime

integer

请求时间。

resultType

string

搜索结果类型。

schema

SearchMetadataSchema

架构。

sort

SearchSort[]

结果的排序方式。

startTime

string

搜索的开始时间。

status

string

搜索结果的状态。

sum

integer

结果集中返回的所有聚合的总和。

top

integer

排名靠前的搜索结果数。

total

integer

搜索结果的总数。

SearchMetadataSchema

用于搜索的架构元数据。

名称 类型 说明
name

string

元数据架构的名称。

version

integer

元数据架构的版本。

SearchSchemaValue

架构结果的值对象。

名称 类型 说明
displayName

string

架构的显示名称。

facet

boolean

指示字段是否为分面的布尔值。

indexed

boolean

指示字段可搜索为自由文本的布尔值。

name

string

架构的名称。

ownerType

string[]

包含 字段的工作流数组。

stored

boolean

指示是否存储字段的布尔值。

type

string

类型。

SearchSort

用于搜索的排序参数。

名称 类型 说明
name

string

搜索查询所依据的字段的名称。

order

SearchSortEnum

搜索的排序顺序。

SearchSortEnum

搜索的排序顺序。

名称 类型 说明
asc

string

desc

string