Table interface

Package:

@azure/arm-operationalinsights

Workspace data table definition.

Extends

ProxyResource

Properties

archiveRetentionInDays	The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) NOTE: This property will not be serialized. It can only be populated by the server.
lastPlanModifiedDate	The timestamp that table plan was last modified (UTC). NOTE: This property will not be serialized. It can only be populated by the server.
plan	Instruct the system how to handle and charge the logs ingested to this table.
provisioningState	Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. NOTE: This property will not be serialized. It can only be populated by the server.
restoredLogs	Parameters of the restore operation that initiated this table.
resultStatistics	Search job execution statistics. NOTE: This property will not be serialized. It can only be populated by the server.
retentionInDays	The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
retentionInDaysAsDefault	True - Value originates from workspace retention in days, False - Customer specific. NOTE: This property will not be serialized. It can only be populated by the server.
schema	Table schema.
searchResults	Parameters of the search job that initiated this table.
systemData	Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
totalRetentionInDays	The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.
totalRetentionInDaysAsDefault	True - Value originates from retention in days, False - Customer specific. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

archiveRetentionInDays

The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) NOTE: This property will not be serialized. It can only be populated by the server.

archiveRetentionInDays?: number

Property Value

number

lastPlanModifiedDate

The timestamp that table plan was last modified (UTC). NOTE: This property will not be serialized. It can only be populated by the server.

lastPlanModifiedDate?: string

Property Value

string

plan

Instruct the system how to handle and charge the logs ingested to this table.

plan?: string

Property Value

string

provisioningState

Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

restoredLogs

Parameters of the restore operation that initiated this table.

restoredLogs?: RestoredLogs

Property Value

RestoredLogs

resultStatistics

Search job execution statistics. NOTE: This property will not be serialized. It can only be populated by the server.

resultStatistics?: ResultStatistics

Property Value

ResultStatistics

retentionInDays

The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.

retentionInDays?: number

Property Value

number

retentionInDaysAsDefault

True - Value originates from workspace retention in days, False - Customer specific. NOTE: This property will not be serialized. It can only be populated by the server.

retentionInDaysAsDefault?: boolean

Property Value

boolean

schema

Table schema.

schema?: Schema

Property Value

Schema

searchResults

Parameters of the search job that initiated this table.

searchResults?: SearchResults

Property Value

SearchResults

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemDataAutoGenerated

Property Value

SystemDataAutoGenerated

totalRetentionInDays

The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.

totalRetentionInDays?: number

Property Value

number

totalRetentionInDaysAsDefault

True - Value originates from retention in days, False - Customer specific. NOTE: This property will not be serialized. It can only be populated by the server.

totalRetentionInDaysAsDefault?: boolean

Property Value

boolean

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type