TimeSeriesInsightsStandardEnvironment
Manages an Azure IoT Time Series Insights Standard Environment.
Example Usage
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "northeurope",
});
var exampleTimeSeriesInsightsStandardEnvironment = new Azure.Iot.TimeSeriesInsightsStandardEnvironment("exampleTimeSeriesInsightsStandardEnvironment", new Azure.Iot.TimeSeriesInsightsStandardEnvironmentArgs
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
SkuName = "S1_1",
DataRetentionTime = "P30D",
});
}
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/iot"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("northeurope"),
})
if err != nil {
return err
}
_, err = iot.NewTimeSeriesInsightsStandardEnvironment(ctx, "exampleTimeSeriesInsightsStandardEnvironment", &iot.TimeSeriesInsightsStandardEnvironmentArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
SkuName: pulumi.String("S1_1"),
DataRetentionTime: pulumi.String("P30D"),
})
if err != nil {
return err
}
return nil
})
}import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_time_series_insights_standard_environment = azure.iot.TimeSeriesInsightsStandardEnvironment("exampleTimeSeriesInsightsStandardEnvironment",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
sku_name="S1_1",
data_retention_time="P30D")import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleTimeSeriesInsightsStandardEnvironment = new azure.iot.TimeSeriesInsightsStandardEnvironment("exampleTimeSeriesInsightsStandardEnvironment", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
skuName: "S1_1",
dataRetentionTime: "P30D",
});Create a TimeSeriesInsightsStandardEnvironment Resource
new TimeSeriesInsightsStandardEnvironment(name: string, args: TimeSeriesInsightsStandardEnvironmentArgs, opts?: CustomResourceOptions);def TimeSeriesInsightsStandardEnvironment(resource_name, opts=None, data_retention_time=None, location=None, name=None, partition_key=None, resource_group_name=None, sku_name=None, storage_limit_exceeded_behavior=None, tags=None, __props__=None);func NewTimeSeriesInsightsStandardEnvironment(ctx *Context, name string, args TimeSeriesInsightsStandardEnvironmentArgs, opts ...ResourceOption) (*TimeSeriesInsightsStandardEnvironment, error)public TimeSeriesInsightsStandardEnvironment(string name, TimeSeriesInsightsStandardEnvironmentArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args TimeSeriesInsightsStandardEnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TimeSeriesInsightsStandardEnvironmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TimeSeriesInsightsStandardEnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
TimeSeriesInsightsStandardEnvironment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The TimeSeriesInsightsStandardEnvironment resource accepts the following input properties:
- Data
Retention stringTime Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
- Resource
Group stringName The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
- Sku
Name string Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(_).The fist part is the
name, valid values include:S1andS2. The second part is thecapacity(e.g. the number of deployed units of thesku), which must be a positiveinteger(e.g.S1_1). Changing this forces a new resource to be created.- Location string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
- Partition
Key string The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
- Storage
Limit stringExceeded Behavior Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include
PauseIngressandPurgeOldData. Defaults toPurgeOldData.- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Data
Retention stringTime Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
- Resource
Group stringName The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
- Sku
Name string Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(_).The fist part is the
name, valid values include:S1andS2. The second part is thecapacity(e.g. the number of deployed units of thesku), which must be a positiveinteger(e.g.S1_1). Changing this forces a new resource to be created.- Location string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
- Partition
Key string The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
- Storage
Limit stringExceeded Behavior Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include
PauseIngressandPurgeOldData. Defaults toPurgeOldData.- map[string]string
A mapping of tags to assign to the resource.
- data
Retention stringTime Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
- resource
Group stringName The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
- sku
Name string Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(_).The fist part is the
name, valid values include:S1andS2. The second part is thecapacity(e.g. the number of deployed units of thesku), which must be a positiveinteger(e.g.S1_1). Changing this forces a new resource to be created.- location string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
- partition
Key string The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
- storage
Limit stringExceeded Behavior Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include
PauseIngressandPurgeOldData. Defaults toPurgeOldData.- {[key: string]: string}
A mapping of tags to assign to the resource.
- data_
retention_ strtime Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
- resource_
group_ strname The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
- sku_
name str Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(_).The fist part is the
name, valid values include:S1andS2. The second part is thecapacity(e.g. the number of deployed units of thesku), which must be a positiveinteger(e.g.S1_1). Changing this forces a new resource to be created.- location str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
- partition_
key str The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
- storage_
limit_ strexceeded_ behavior Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include
PauseIngressandPurgeOldData. Defaults toPurgeOldData.- Dict[str, str]
A mapping of tags to assign to the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the TimeSeriesInsightsStandardEnvironment resource produces the following output properties:
Look up an Existing TimeSeriesInsightsStandardEnvironment Resource
Get an existing TimeSeriesInsightsStandardEnvironment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TimeSeriesInsightsStandardEnvironmentState, opts?: CustomResourceOptions): TimeSeriesInsightsStandardEnvironmentstatic get(resource_name, id, opts=None, data_retention_time=None, location=None, name=None, partition_key=None, resource_group_name=None, sku_name=None, storage_limit_exceeded_behavior=None, tags=None, __props__=None);func GetTimeSeriesInsightsStandardEnvironment(ctx *Context, name string, id IDInput, state *TimeSeriesInsightsStandardEnvironmentState, opts ...ResourceOption) (*TimeSeriesInsightsStandardEnvironment, error)public static TimeSeriesInsightsStandardEnvironment Get(string name, Input<string> id, TimeSeriesInsightsStandardEnvironmentState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Data
Retention stringTime Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
- Location string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
- Partition
Key string The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
- Resource
Group stringName The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
- Sku
Name string Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(_).The fist part is the
name, valid values include:S1andS2. The second part is thecapacity(e.g. the number of deployed units of thesku), which must be a positiveinteger(e.g.S1_1). Changing this forces a new resource to be created.- Storage
Limit stringExceeded Behavior Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include
PauseIngressandPurgeOldData. Defaults toPurgeOldData.- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Data
Retention stringTime Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
- Location string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
- Partition
Key string The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
- Resource
Group stringName The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
- Sku
Name string Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(_).The fist part is the
name, valid values include:S1andS2. The second part is thecapacity(e.g. the number of deployed units of thesku), which must be a positiveinteger(e.g.S1_1). Changing this forces a new resource to be created.- Storage
Limit stringExceeded Behavior Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include
PauseIngressandPurgeOldData. Defaults toPurgeOldData.- map[string]string
A mapping of tags to assign to the resource.
- data
Retention stringTime Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
- location string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
- partition
Key string The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
- resource
Group stringName The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
- sku
Name string Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(_).The fist part is the
name, valid values include:S1andS2. The second part is thecapacity(e.g. the number of deployed units of thesku), which must be a positiveinteger(e.g.S1_1). Changing this forces a new resource to be created.- storage
Limit stringExceeded Behavior Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include
PauseIngressandPurgeOldData. Defaults toPurgeOldData.- {[key: string]: string}
A mapping of tags to assign to the resource.
- data_
retention_ strtime Specifies the ISO8601 timespan specifying the minimum number of days the environment’s events will be available for query. Changing this forces a new resource to be created.
- location str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
Specifies the name of the Azure IoT Time Series Insights Standard Environment. Changing this forces a new resource to be created. Must be globally unique.
- partition_
key str The name of the event property which will be used to partition data. Changing this forces a new resource to be created.
- resource_
group_ strname The name of the resource group in which to create the Azure IoT Time Series Insights Standard Environment.
- sku_
name str Specifies the SKU Name for this IoT Time Series Insights Standard Environment. It is string consisting of two parts separated by an underscore(_).The fist part is the
name, valid values include:S1andS2. The second part is thecapacity(e.g. the number of deployed units of thesku), which must be a positiveinteger(e.g.S1_1). Changing this forces a new resource to be created.- storage_
limit_ strexceeded_ behavior Specifies the behavior the IoT Time Series Insights service should take when the environment’s capacity has been exceeded. Valid values include
PauseIngressandPurgeOldData. Defaults toPurgeOldData.- Dict[str, str]
A mapping of tags to assign to the resource.
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.