Gen1EnvironmentResource interface

Package:

@azure/arm-timeseriesinsights

An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen1 environments have data retention limits.

Extends

EnvironmentResource

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.
kind	Polymorphic discriminator, which specifies the different types this object can be
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 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.
location	Resource location
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
sku	The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.
tags	Resource tags
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

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

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

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

dataRetentionTime

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

dataRetentionTime: string

Property Value

string

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "Gen1"

Property Value

"Gen1"

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[]

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

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

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 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 EnvironmentResource.id

location

Resource location

location: string

Property Value

string

Inherited From EnvironmentResource.location

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 EnvironmentResource.name

sku

The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

sku: Sku

Property Value

Sku

Inherited From EnvironmentResource.sku

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From EnvironmentResource.tags

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 EnvironmentResource.type