Gen1EnvironmentResourceProperties interface

Package:

@azure/arm-timeseriesinsights

Properties of the Gen1 environment.

Extends

Gen1EnvironmentCreationProperties,EnvironmentResourceProperties

Inherited Properties

creationTime	The time the resource was created. NOTE: This property will not be serialized. It can only be populated by the server.
dataAccessFqdn	The fully qualified domain name used to access the environment data, e.g. to query the environment's events or upload reference data for the environment. NOTE: This property will not be serialized. It can only be populated by the server.
dataAccessId	An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment. NOTE: This property will not be serialized. It can only be populated by the server.
dataRetentionTime	ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
partitionKeyProperties	The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.
provisioningState	Provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
status	An object that represents the status of the environment, and its internal state in the Time Series Insights service. NOTE: This property will not be serialized. It can only be populated by the server.
storageLimitExceededBehavior	The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.

Inherited Property Details

creationTime

The time the resource was created. NOTE: This property will not be serialized. It can only be populated by the server.

creationTime?: Date

Property Value

Date

Inherited From EnvironmentResourceProperties.creationTime

dataAccessFqdn

The fully qualified domain name used to access the environment data, e.g. to query the environment's events or upload reference data for the environment. NOTE: This property will not be serialized. It can only be populated by the server.

dataAccessFqdn?: string

Property Value

string

Inherited From EnvironmentResourceProperties.dataAccessFqdn

dataAccessId

An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment. NOTE: This property will not be serialized. It can only be populated by the server.

dataAccessId?: string

Property Value

string

Inherited From EnvironmentResourceProperties.dataAccessId

dataRetentionTime

ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.

dataRetentionTime: string

Property Value

string

Inherited From Gen1EnvironmentCreationProperties.dataRetentionTime

partitionKeyProperties

The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.

partitionKeyProperties?: TimeSeriesIdProperty[]

Property Value

TimeSeriesIdProperty[]

Inherited From Gen1EnvironmentCreationProperties.partitionKeyProperties

provisioningState

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

provisioningState?: string

Property Value

string

Inherited From EnvironmentResourceProperties.provisioningState

status

An object that represents the status of the environment, and its internal state in the Time Series Insights service. NOTE: This property will not be serialized. It can only be populated by the server.

status?: EnvironmentStatus

Property Value

EnvironmentStatus

Inherited From EnvironmentResourceProperties.status

storageLimitExceededBehavior

The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.

storageLimitExceededBehavior?: string

Property Value

string

Inherited From Gen1EnvironmentCreationProperties.storageLimitExceededBehavior