Class Gen1EnvironmentResource
java.lang.Object
com.azure.core.management.ProxyResource
com.azure.core.management.Resource
com.azure.resourcemanager.timeseriesinsights.fluent.models.EnvironmentResourceInner
com.azure.resourcemanager.timeseriesinsights.models.Gen1EnvironmentResource
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.
-
Constructor Summary
ConstructorDescriptionCreates an instance of Gen1EnvironmentResource class. -
Method Summary
Modifier and TypeMethodDescriptionGet the creationTime property: The time the resource was created.Get the dataAccessFqdn property: The fully qualified domain name used to access the environment data, e.g.Get the dataAccessId property: An id used to access the environment data, e.g.Get the dataRetentionTime property: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.Get the partitionKeyProperties property: The list of event properties which will be used to partition data in the environment.Get the provisioningState property: Provisioning state of the resource.status()
Get the status property: An object that represents the status of the environment, and its internal state in the Time Series Insights service.Get the storageLimitExceededBehavior property: The behavior the Time Series Insights service should take when the environment's capacity has been exceeded.void
validate()
Validates the instance.withDataRetentionTime
(Duration dataRetentionTime) Set the dataRetentionTime property: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.withLocation
(String location) withPartitionKeyProperties
(List<TimeSeriesIdProperty> partitionKeyProperties) Set the partitionKeyProperties property: The list of event properties which will be used to partition data in the environment.Set the sku property: The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1).withStorageLimitExceededBehavior
(StorageLimitExceededBehavior storageLimitExceededBehavior) Set the storageLimitExceededBehavior property: The behavior the Time Series Insights service should take when the environment's capacity has been exceeded.Methods inherited from class com.azure.resourcemanager.timeseriesinsights.fluent.models.EnvironmentResourceInner
sku
Methods inherited from class com.azure.core.management.Resource
location, tags
Methods inherited from class com.azure.core.management.ProxyResource
id, name, type
-
Constructor Details
-
Gen1EnvironmentResource
public Gen1EnvironmentResource()Creates an instance of Gen1EnvironmentResource class.
-
-
Method Details
-
withSku
Set the sku property: 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.- Overrides:
withSku
in classEnvironmentResourceInner
- Parameters:
sku
- the sku value to set.- Returns:
- the EnvironmentResourceInner object itself.
-
withLocation
- Overrides:
withLocation
in classEnvironmentResourceInner
-
withTags
- Overrides:
withTags
in classEnvironmentResourceInner
-
dataAccessId
Get the dataAccessId property: An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.- Returns:
- the dataAccessId value.
-
dataAccessFqdn
Get the dataAccessFqdn property: 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.- Returns:
- the dataAccessFqdn value.
-
status
Get the status property: An object that represents the status of the environment, and its internal state in the Time Series Insights service.- Returns:
- the status value.
-
provisioningState
Get the provisioningState property: Provisioning state of the resource.- Returns:
- the provisioningState value.
-
creationTime
Get the creationTime property: The time the resource was created.- Returns:
- the creationTime value.
-
dataRetentionTime
Get the dataRetentionTime property: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.- Returns:
- the dataRetentionTime value.
-
withDataRetentionTime
Set the dataRetentionTime property: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.- Parameters:
dataRetentionTime
- the dataRetentionTime value to set.- Returns:
- the Gen1EnvironmentResource object itself.
-
storageLimitExceededBehavior
Get the storageLimitExceededBehavior property: 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.- Returns:
- the storageLimitExceededBehavior value.
-
withStorageLimitExceededBehavior
public Gen1EnvironmentResource withStorageLimitExceededBehavior(StorageLimitExceededBehavior storageLimitExceededBehavior) Set the storageLimitExceededBehavior property: 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.- Parameters:
storageLimitExceededBehavior
- the storageLimitExceededBehavior value to set.- Returns:
- the Gen1EnvironmentResource object itself.
-
partitionKeyProperties
Get the partitionKeyProperties property: The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.- Returns:
- the partitionKeyProperties value.
-
withPartitionKeyProperties
public Gen1EnvironmentResource withPartitionKeyProperties(List<TimeSeriesIdProperty> partitionKeyProperties) Set the partitionKeyProperties property: The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.- Parameters:
partitionKeyProperties
- the partitionKeyProperties value to set.- Returns:
- the Gen1EnvironmentResource object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classEnvironmentResourceInner
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-