Gen1EnvironmentResource Class

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.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.timeseriesinsights.models._models_py3.EnvironmentResource

Gen1EnvironmentResource

Constructor

Gen1EnvironmentResource(*, location: str, sku: azure.mgmt.timeseriesinsights.models._models_py3.Sku, data_retention_time: datetime.timedelta, tags: Optional[Dict[str, str]] = None, storage_limit_exceeded_behavior: Optional[Union[str, azure.mgmt.timeseriesinsights.models._time_series_insights_client_enums.StorageLimitExceededBehavior]] = None, partition_key_properties: Optional[List[azure.mgmt.timeseriesinsights.models._models_py3.TimeSeriesIdProperty]] = None, **kwargs)

Parameters

location

str

Required

Required. Resource location.

tags

dict[str, str]

Required

A set of tags. Resource tags.

sku

Sku

Required

Required. 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.

kind

str or EnvironmentResourceKind

Required

Required. The kind of the environment.Constant filled by server. Possible values include: "Gen1", "Gen2".

data_retention_time

timedelta

Required

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

storage_limit_exceeded_behavior

str or StorageLimitExceededBehavior

Required

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. Possible values include: "PurgeOldData", "PauseIngress".

partition_key_properties

list[TimeSeriesIdProperty]

Required

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

Variables

id

str

Resource Id.

name

str

Resource name.

type

str

Resource type.

provisioning_state

str or ProvisioningState

Provisioning state of the resource. Possible values include: "Accepted", "Creating", "Updating", "Succeeded", "Failed", "Deleting".

creation_time

datetime

The time the resource was created.

data_access_id

str

An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.

data_access_fqdn

str

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.

status

EnvironmentStatus

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