Package-level declarations

Types

Link copied to clipboard
data class EnvironmentStateDetailsResponse(val code: String? = null, val message: String? = null)

An object that contains the details about an environment's state.

Link copied to clipboard

An object that represents the status of the environment, and its internal state in the Time Series Insights service.

Link copied to clipboard
data class Gen2StorageConfigurationOutputResponse(val accountName: String)

The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data.

Link copied to clipboard
data class GetAccessPolicyResult(val azureApiVersion: String, val description: String? = null, val id: String, val name: String, val principalObjectId: String? = null, val roles: List<String>? = null, val type: String)

An access policy is used to grant users and applications access to the environment. Roles are assigned to service principals in Azure Active Directory. These roles define the actions the principal can perform through the Time Series Insights data plane APIs.

Link copied to clipboard
data class GetEventHubEventSourceResult(val azureApiVersion: String, val consumerGroupName: String, val creationTime: String, val eventHubName: String, val eventSourceResourceId: String, val id: String, val keyName: String, val kind: String, val localTimestamp: LocalTimestampResponse? = null, val location: String, val name: String, val provisioningState: String, val serviceBusNamespace: String, val tags: Map<String, String>? = null, val time: String? = null, val timestampPropertyName: String? = null, val type: String)

An event source that receives its data from an Azure EventHub.

Link copied to clipboard
data class GetGen1EnvironmentResult(val azureApiVersion: String, val creationTime: String, val dataAccessFqdn: String, val dataAccessId: String, val dataRetentionTime: String, val id: String, val kind: String, val location: String, val name: String, val partitionKeyProperties: List<TimeSeriesIdPropertyResponse>? = null, val provisioningState: String, val sku: SkuResponse, val status: EnvironmentStatusResponse, val storageLimitExceededBehavior: String? = null, val tags: Map<String, String>? = null, val type: String)

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.

Link copied to clipboard
data class GetGen2EnvironmentResult(val azureApiVersion: String, val creationTime: String, val dataAccessFqdn: String, val dataAccessId: String, val id: String, val kind: String, val location: String, val name: String, val provisioningState: String, val sku: SkuResponse, val status: EnvironmentStatusResponse, val storageConfiguration: Gen2StorageConfigurationOutputResponse, val tags: Map<String, String>? = null, val timeSeriesIdProperties: List<TimeSeriesIdPropertyResponse>, val type: String, val warmStoreConfiguration: WarmStoreConfigurationPropertiesResponse? = null)

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.

Link copied to clipboard
data class GetIoTHubEventSourceResult(val azureApiVersion: String, val consumerGroupName: String, val creationTime: String, val eventSourceResourceId: String, val id: String, val iotHubName: String, val keyName: String, val kind: String, val localTimestamp: LocalTimestampResponse? = null, val location: String, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val time: String? = null, val timestampPropertyName: String? = null, val type: String)

An event source that receives its data from an Azure IoTHub.

Link copied to clipboard
data class GetReferenceDataSetResult(val azureApiVersion: String, val creationTime: String, val dataStringComparisonBehavior: String? = null, val id: String, val keyProperties: List<ReferenceDataSetKeyPropertyResponse>, val location: String, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val type: String)

A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs.

Link copied to clipboard
data class IngressEnvironmentStatusResponse(val state: String? = null, val stateDetails: EnvironmentStateDetailsResponse)

An object that represents the status of ingress on an environment.

Link copied to clipboard
data class LocalTimestampResponse(val format: String? = null, val timeZoneOffset: LocalTimestampResponseTimeZoneOffset? = null)

An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.

Link copied to clipboard
data class LocalTimestampResponseTimeZoneOffset(val propertyName: String? = null)

An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.

Link copied to clipboard
data class ReferenceDataSetKeyPropertyResponse(val name: String? = null, val type: String? = null)

A key property for the reference data set. A reference data set can have multiple key properties.

Link copied to clipboard
data class SkuResponse(val capacity: Int, val name: String)

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.

Link copied to clipboard
data class TimeSeriesIdPropertyResponse(val name: String? = null, val type: String? = null)

The structure of the property that a time series id can have. An environment can have multiple such properties.

Link copied to clipboard
data class WarmStorageEnvironmentStatusResponse(val currentCount: Int? = null, val maxCount: Int? = null, val state: String? = null)

An object that represents the status of warm storage on an environment.

Link copied to clipboard
data class WarmStoreConfigurationPropertiesResponse(val dataRetention: String)

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.