azure-native.timeseriesinsights.Gen1Environment
Explore with Pulumi AI
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. API Version: 2020-05-15.
Create Gen1Environment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Gen1Environment(name: string, args: Gen1EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Gen1Environment(resource_name: str,
args: Gen1EnvironmentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Gen1Environment(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_retention_time: Optional[str] = None,
resource_group_name: Optional[str] = None,
sku: Optional[SkuArgs] = None,
environment_name: Optional[str] = None,
location: Optional[str] = None,
partition_key_properties: Optional[Sequence[TimeSeriesIdPropertyArgs]] = None,
storage_limit_exceeded_behavior: Optional[Union[str, StorageLimitExceededBehavior]] = None,
tags: Optional[Mapping[str, str]] = None)
func NewGen1Environment(ctx *Context, name string, args Gen1EnvironmentArgs, opts ...ResourceOption) (*Gen1Environment, error)
public Gen1Environment(string name, Gen1EnvironmentArgs args, CustomResourceOptions? opts = null)
public Gen1Environment(String name, Gen1EnvironmentArgs args)
public Gen1Environment(String name, Gen1EnvironmentArgs args, CustomResourceOptions options)
type: azure-native:timeseriesinsights:Gen1Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. Gen1EnvironmentArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. Gen1EnvironmentArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. Gen1EnvironmentArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. Gen1EnvironmentArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. Gen1EnvironmentArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gen1EnvironmentResource = new AzureNative.Timeseriesinsights.Gen1Environment("gen1EnvironmentResource", new()
{
DataRetentionTime = "string",
Kind = "string",
ResourceGroupName = "string",
Sku =
{
{ "capacity", 0 },
{ "name", "string" },
},
EnvironmentName = "string",
Location = "string",
PartitionKeyProperties = new[]
{
{
{ "name", "string" },
{ "type", "string" },
},
},
StorageLimitExceededBehavior = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := timeseriesinsights.NewGen1Environment(ctx, "gen1EnvironmentResource", ×eriesinsights.Gen1EnvironmentArgs{
DataRetentionTime: "string",
Kind: "string",
ResourceGroupName: "string",
Sku: map[string]interface{}{
"capacity": 0,
"name": "string",
},
EnvironmentName: "string",
Location: "string",
PartitionKeyProperties: []map[string]interface{}{
map[string]interface{}{
"name": "string",
"type": "string",
},
},
StorageLimitExceededBehavior: "string",
Tags: map[string]interface{}{
"string": "string",
},
})
var gen1EnvironmentResource = new Gen1Environment("gen1EnvironmentResource", Gen1EnvironmentArgs.builder()
.dataRetentionTime("string")
.kind("string")
.resourceGroupName("string")
.sku(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.environmentName("string")
.location("string")
.partitionKeyProperties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.storageLimitExceededBehavior("string")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
gen1_environment_resource = azure_native.timeseriesinsights.Gen1Environment("gen1EnvironmentResource",
data_retention_time=string,
kind=string,
resource_group_name=string,
sku={
capacity: 0,
name: string,
},
environment_name=string,
location=string,
partition_key_properties=[{
name: string,
type: string,
}],
storage_limit_exceeded_behavior=string,
tags={
string: string,
})
const gen1EnvironmentResource = new azure_native.timeseriesinsights.Gen1Environment("gen1EnvironmentResource", {
dataRetentionTime: "string",
kind: "string",
resourceGroupName: "string",
sku: {
capacity: 0,
name: "string",
},
environmentName: "string",
location: "string",
partitionKeyProperties: [{
name: "string",
type: "string",
}],
storageLimitExceededBehavior: "string",
tags: {
string: "string",
},
});
type: azure-native:timeseriesinsights:Gen1Environment
properties:
dataRetentionTime: string
environmentName: string
kind: string
location: string
partitionKeyProperties:
- name: string
type: string
resourceGroupName: string
sku:
capacity: 0
name: string
storageLimitExceededBehavior: string
tags:
string: string
Gen1Environment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Gen1Environment resource accepts the following input properties:
- Data
Retention Time This property is required. string - ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- Sku
This property is required. Pulumi.Azure Native. Time Series Insights. Inputs. 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.
- Environment
Name Changes to this property will trigger replacement.
- Name of the environment
- Location
Changes to this property will trigger replacement.
- The location of the resource.
- Partition
Key List<Pulumi.Properties Azure Native. Time Series Insights. Inputs. Time Series Id 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.
- Storage
Limit string | Pulumi.Exceeded Behavior Azure Native. Time Series Insights. Storage Limit Exceeded Behavior - 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.
- Dictionary<string, string>
- Key-value pairs of additional properties for the resource.
- Data
Retention Time This property is required. string - ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- Sku
This property is required. SkuArgs - 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.
- Environment
Name Changes to this property will trigger replacement.
- Name of the environment
- Location
Changes to this property will trigger replacement.
- The location of the resource.
- Partition
Key []TimeProperties Series Id Property Args - The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.
- Storage
Limit string | StorageExceeded Behavior Limit Exceeded Behavior - 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.
- map[string]string
- Key-value pairs of additional properties for the resource.
- data
Retention Time This property is required. String - ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- sku
This property is required. 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.
- environment
Name Changes to this property will trigger replacement.
- Name of the environment
- location
Changes to this property will trigger replacement.
- The location of the resource.
- partition
Key List<TimeProperties Series Id 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.
- storage
Limit String | StorageExceeded Behavior Limit Exceeded Behavior - 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.
- Map<String,String>
- Key-value pairs of additional properties for the resource.
- data
Retention Time This property is required. string - ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- sku
This property is required. 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.
- environment
Name Changes to this property will trigger replacement.
- Name of the environment
- location
Changes to this property will trigger replacement.
- The location of the resource.
- partition
Key TimeProperties Series Id 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.
- storage
Limit string | StorageExceeded Behavior Limit Exceeded Behavior - 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.
- {[key: string]: string}
- Key-value pairs of additional properties for the resource.
- data_
retention_ time This property is required. str - ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- sku
This property is required. SkuArgs - 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.
- environment_
name Changes to this property will trigger replacement.
- Name of the environment
- location
Changes to this property will trigger replacement.
- The location of the resource.
- partition_
key_ Sequence[Timeproperties Series Id Property Args] - The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.
- storage_
limit_ str | Storageexceeded_ behavior Limit Exceeded Behavior - 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.
- Mapping[str, str]
- Key-value pairs of additional properties for the resource.
- data
Retention Time This property is required. String - ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- sku
This property is required. Property Map - 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.
- environment
Name Changes to this property will trigger replacement.
- Name of the environment
- location
Changes to this property will trigger replacement.
- The location of the resource.
- partition
Key List<Property Map>Properties - The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.
- storage
Limit String | "PurgeExceeded Behavior Old Data" | "Pause Ingress" - 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.
- Map<String>
- Key-value pairs of additional properties for the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Gen1Environment resource produces the following output properties:
- Creation
Time string - The time the resource was created.
- Data
Access stringFqdn - 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.
- Data
Access stringId - An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name
- Provisioning
State string - Provisioning state of the resource.
- Status
Pulumi.
Azure Native. Time Series Insights. Outputs. Environment Status Response - An object that represents the status of the environment, and its internal state in the Time Series Insights service.
- Type string
- Resource type
- Creation
Time string - The time the resource was created.
- Data
Access stringFqdn - 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.
- Data
Access stringId - An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name
- Provisioning
State string - Provisioning state of the resource.
- Status
Environment
Status Response - An object that represents the status of the environment, and its internal state in the Time Series Insights service.
- Type string
- Resource type
- creation
Time String - The time the resource was created.
- data
Access StringFqdn - 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.
- data
Access StringId - An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name
- provisioning
State String - Provisioning state of the resource.
- status
Environment
Status Response - An object that represents the status of the environment, and its internal state in the Time Series Insights service.
- type String
- Resource type
- creation
Time string - The time the resource was created.
- data
Access stringFqdn - 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.
- data
Access stringId - An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name
- provisioning
State string - Provisioning state of the resource.
- status
Environment
Status Response - An object that represents the status of the environment, and its internal state in the Time Series Insights service.
- type string
- Resource type
- creation_
time str - The time the resource was created.
- data_
access_ strfqdn - 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.
- data_
access_ strid - An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Resource name
- provisioning_
state str - Provisioning state of the resource.
- status
Environment
Status Response - An object that represents the status of the environment, and its internal state in the Time Series Insights service.
- type str
- Resource type
- creation
Time String - The time the resource was created.
- data
Access StringFqdn - 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.
- data
Access StringId - An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name
- provisioning
State String - Provisioning state of the resource.
- status Property Map
- An object that represents the status of the environment, and its internal state in the Time Series Insights service.
- type String
- Resource type
Supporting Types
EnvironmentStateDetailsResponse, EnvironmentStateDetailsResponseArgs
EnvironmentStatusResponse, EnvironmentStatusResponseArgs
- Ingress
This property is required. Pulumi.Azure Native. Time Series Insights. Inputs. Ingress Environment Status Response - An object that represents the status of ingress on an environment.
- Warm
Storage This property is required. Pulumi.Azure Native. Time Series Insights. Inputs. Warm Storage Environment Status Response - An object that represents the status of warm storage on an environment.
- Ingress
This property is required. IngressEnvironment Status Response - An object that represents the status of ingress on an environment.
- Warm
Storage This property is required. WarmStorage Environment Status Response - An object that represents the status of warm storage on an environment.
- ingress
This property is required. IngressEnvironment Status Response - An object that represents the status of ingress on an environment.
- warm
Storage This property is required. WarmStorage Environment Status Response - An object that represents the status of warm storage on an environment.
- ingress
This property is required. IngressEnvironment Status Response - An object that represents the status of ingress on an environment.
- warm
Storage This property is required. WarmStorage Environment Status Response - An object that represents the status of warm storage on an environment.
- ingress
This property is required. IngressEnvironment Status Response - An object that represents the status of ingress on an environment.
- warm_
storage This property is required. WarmStorage Environment Status Response - An object that represents the status of warm storage on an environment.
- ingress
This property is required. Property Map - An object that represents the status of ingress on an environment.
- warm
Storage This property is required. Property Map - An object that represents the status of warm storage on an environment.
IngressEnvironmentStatusResponse, IngressEnvironmentStatusResponseArgs
- State
Details This property is required. Pulumi.Azure Native. Time Series Insights. Inputs. Environment State Details Response - An object that contains the details about an environment's state.
- State string
- This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown"
- State
Details This property is required. EnvironmentState Details Response - An object that contains the details about an environment's state.
- State string
- This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown"
- state
Details This property is required. EnvironmentState Details Response - An object that contains the details about an environment's state.
- state String
- This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown"
- state
Details This property is required. EnvironmentState Details Response - An object that contains the details about an environment's state.
- state string
- This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown"
- state_
details This property is required. EnvironmentState Details Response - An object that contains the details about an environment's state.
- state str
- This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown"
- state
Details This property is required. Property Map - An object that contains the details about an environment's state.
- state String
- This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown"
PropertyType, PropertyTypeArgs
- String
- String
- Property
Type String - String
- String
- String
- String
- String
- STRING
- String
- "String"
- String
Sku, SkuArgs
- Capacity
This property is required. int - The capacity of the sku. For Gen1 environments, this value can be changed to support scale out of environments after they have been created.
- Name
This property is required. string | Pulumi.Azure Native. Time Series Insights. Sku Name - The name of this SKU.
- capacity
This property is required. Number - The capacity of the sku. For Gen1 environments, this value can be changed to support scale out of environments after they have been created.
- name
This property is required. String | "S1" | "S2" | "P1" | "L1" - The name of this SKU.
SkuName, SkuNameArgs
- S1
- S1
- S2
- S2
- P1
- P1
- L1
- L1
- Sku
Name S1 - S1
- Sku
Name S2 - S2
- Sku
Name P1 - P1
- Sku
Name L1 - L1
- S1
- S1
- S2
- S2
- P1
- P1
- L1
- L1
- S1
- S1
- S2
- S2
- P1
- P1
- L1
- L1
- S1
- S1
- S2
- S2
- P1
- P1
- L1
- L1
- "S1"
- S1
- "S2"
- S2
- "P1"
- P1
- "L1"
- L1
SkuResponse, SkuResponseArgs
StorageLimitExceededBehavior, StorageLimitExceededBehaviorArgs
- Purge
Old Data - PurgeOldData
- Pause
Ingress - PauseIngress
- Storage
Limit Exceeded Behavior Purge Old Data - PurgeOldData
- Storage
Limit Exceeded Behavior Pause Ingress - PauseIngress
- Purge
Old Data - PurgeOldData
- Pause
Ingress - PauseIngress
- Purge
Old Data - PurgeOldData
- Pause
Ingress - PauseIngress
- PURGE_OLD_DATA
- PurgeOldData
- PAUSE_INGRESS
- PauseIngress
- "Purge
Old Data" - PurgeOldData
- "Pause
Ingress" - PauseIngress
TimeSeriesIdProperty, TimeSeriesIdPropertyArgs
- Name string
- The name of the property.
- Type
string | Pulumi.
Azure Native. Time Series Insights. Property Type - The type of the property.
- Name string
- The name of the property.
- Type
string | Property
Type - The type of the property.
- name String
- The name of the property.
- type
String | Property
Type - The type of the property.
- name string
- The name of the property.
- type
string | Property
Type - The type of the property.
- name str
- The name of the property.
- type
str | Property
Type - The type of the property.
TimeSeriesIdPropertyResponse, TimeSeriesIdPropertyResponseArgs
WarmStorageEnvironmentStatusResponse, WarmStorageEnvironmentStatusResponseArgs
- Current
Count int - A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU
- Max
Count int - A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU.
- State string
- This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".
- Current
Count int - A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU
- Max
Count int - A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU.
- State string
- This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".
- current
Count Integer - A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU
- max
Count Integer - A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU.
- state String
- This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".
- current
Count number - A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU
- max
Count number - A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU.
- state string
- This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".
- current_
count int - A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU
- max_
count int - A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU.
- state str
- This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".
- current
Count Number - A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU
- max
Count Number - A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU.
- state String
- This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:timeseriesinsights:Gen1Environment env1 /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0