Skip to main content

schemata

Creates, updates, deletes, gets or lists a schemata resource.

Overview

Nameschemata
TypeResource
Idazure.log_analytics.schemata

Fields

The following fields are returned by SELECT queries:

OK response definition.

NameDatatypeDescription
namestringThe name of the schema.
displayNamestringThe display name of the schema.
facetbooleanThe boolean that indicates whether or not the field is a facet.
indexedbooleanThe boolean that indicates the field is searchable as free text.
ownerTypearrayThe array of workflows containing the field.
storedbooleanThe boolean that indicates whether or not the field is stored.
typestringThe type.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresourceGroupName, workspaceName, subscriptionIdGets the schema for a given workspace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
resourceGroupNamestringThe name of the resource group. The name is case insensitive.
subscriptionIdstringThe ID of the target subscription.
workspaceNamestringThe name of the workspace.

SELECT examples

Gets the schema for a given workspace.

SELECT
name,
displayName,
facet,
indexed,
ownerType,
stored,
type
FROM azure.log_analytics.schemata
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;