Gen2EnvironmentResource interface

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

Extends

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.

kind

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

privateEndpointConnections

The list of private endpoint connections to the environment. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState

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

publicNetworkAccess

If 'enabled', public network access is allowed. If 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.

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.

storageConfiguration

The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.

timeSeriesIdProperties

The list of event properties which will be used to define the environment's time series id.

warmStoreConfiguration

The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.

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

kind

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

kind: "Gen2"

Property Value

"Gen2"

privateEndpointConnections

The list of private endpoint connections to the environment. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

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

publicNetworkAccess

If 'enabled', public network access is allowed. If 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.

publicNetworkAccess?: 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

storageConfiguration

The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.

storageConfiguration: Gen2StorageConfigurationOutput

Property Value

timeSeriesIdProperties

The list of event properties which will be used to define the environment's time series id.

timeSeriesIdProperties: TimeSeriesIdProperty[]

Property Value

warmStoreConfiguration

The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.

warmStoreConfiguration?: WarmStoreConfigurationProperties

Property Value

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