TableProperties interface

Table properties.

Properties

archiveRetentionInDays

The tables long-term retention in days. Calculated as (totalRetentionInDays-retentionInDays).

lastPlanModifiedDate

The timestamp that table plan was last modified (UTC).

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.

restoredLogs

Parameters of the restore operation that initiated this table.

resultStatistics

Search job execution statistics.

retentionInDays

In Analytics table: the tables analytics retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. In Basic and Auxiliary table: read only property.

retentionInDaysAsDefault

True - Value originates from workspace retention in days, False - Customer specific.

schema

Table schema.

searchResults

Parameters of the search job that initiated this table.

totalRetentionInDays

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

totalRetentionInDaysAsDefault

True - Value originates from retention in days, False - Customer specific.

Property Details

archiveRetentionInDays

The tables long-term retention in days. Calculated as (totalRetentionInDays-retentionInDays).

archiveRetentionInDays?: number

Property Value

number

lastPlanModifiedDate

The timestamp that table plan was last modified (UTC).

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.

provisioningState?: string

Property Value

string

restoredLogs

Parameters of the restore operation that initiated this table.

restoredLogs?: RestoredLogs

Property Value

resultStatistics

Search job execution statistics.

resultStatistics?: ResultStatistics

Property Value

retentionInDays

In Analytics table: the tables analytics retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. In Basic and Auxiliary table: read only property.

retentionInDays?: number

Property Value

number

retentionInDaysAsDefault

True - Value originates from workspace retention in days, False - Customer specific.

retentionInDaysAsDefault?: boolean

Property Value

boolean

schema

Table schema.

schema?: Schema

Property Value

searchResults

Parameters of the search job that initiated this table.

searchResults?: SearchResults

Property Value

totalRetentionInDays

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

totalRetentionInDays?: number

Property Value

number

totalRetentionInDaysAsDefault

True - Value originates from retention in days, False - Customer specific.

totalRetentionInDaysAsDefault?: boolean

Property Value

boolean