Azure Native v2 v2.90.0, Mar 27 25

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.timeseriesinsights.getGen1Environment

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Using getGen1Environment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getGen1Environment(args: GetGen1EnvironmentArgs, opts?: InvokeOptions): Promise<GetGen1EnvironmentResult>
function getGen1EnvironmentOutput(args: GetGen1EnvironmentOutputArgs, opts?: InvokeOptions): Output<GetGen1EnvironmentResult>

def get_gen1_environment(environment_name: Optional[str] = None,
                         expand: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetGen1EnvironmentResult
def get_gen1_environment_output(environment_name: Optional[pulumi.Input[str]] = None,
                         expand: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetGen1EnvironmentResult]

func LookupGen1Environment(ctx *Context, args *LookupGen1EnvironmentArgs, opts ...InvokeOption) (*LookupGen1EnvironmentResult, error)
func LookupGen1EnvironmentOutput(ctx *Context, args *LookupGen1EnvironmentOutputArgs, opts ...InvokeOption) LookupGen1EnvironmentResultOutput

> Note: This function is named LookupGen1Environment in the Go SDK.

public static class GetGen1Environment 
{
    public static Task<GetGen1EnvironmentResult> InvokeAsync(GetGen1EnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetGen1EnvironmentResult> Invoke(GetGen1EnvironmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGen1EnvironmentResult> getGen1Environment(GetGen1EnvironmentArgs args, InvokeOptions options)
public static Output<GetGen1EnvironmentResult> getGen1Environment(GetGen1EnvironmentArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:timeseriesinsights:getGen1Environment
  arguments:
    # arguments dictionary

The following arguments are supported:

EnvironmentName string: The name of the Time Series Insights environment associated with the specified resource group.
ResourceGroupName string: Name of an Azure Resource group.
Expand string: Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

EnvironmentName string: The name of the Time Series Insights environment associated with the specified resource group.
ResourceGroupName string: Name of an Azure Resource group.
Expand string: Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

environmentName String: The name of the Time Series Insights environment associated with the specified resource group.
resourceGroupName String: Name of an Azure Resource group.
expand String: Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

environmentName string: The name of the Time Series Insights environment associated with the specified resource group.
resourceGroupName string: Name of an Azure Resource group.
expand string: Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

environment_name str: The name of the Time Series Insights environment associated with the specified resource group.
resource_group_name str: Name of an Azure Resource group.
expand str: Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

environmentName String: The name of the Time Series Insights environment associated with the specified resource group.
resourceGroupName String: Name of an Azure Resource group.
expand String: Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

getGen1Environment Result

The following output properties are available:

CreationTime string: The time the resource was created.
DataAccessFqdn string: 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.
DataAccessId string: An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
DataRetentionTime string: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
Id string: Resource Id
Location string: Resource location
Name string: Resource name
ProvisioningState string: Provisioning state of the resource.
Sku Pulumi.AzureNative.TimeSeriesInsights.Outputs.SkuResponse: 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.
Status Pulumi.AzureNative.TimeSeriesInsights.Outputs.EnvironmentStatusResponse: An object that represents the status of the environment, and its internal state in the Time Series Insights service.
Type string: Resource type
PartitionKeyProperties List<Pulumi.AzureNative.TimeSeriesInsights.Outputs.TimeSeriesIdPropertyResponse>: The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.
StorageLimitExceededBehavior string: 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.
Tags Dictionary<string, string>: Resource tags

CreationTime string: The time the resource was created.
DataAccessFqdn string: 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.
DataAccessId string: An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
DataRetentionTime string: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
Id string: Resource Id
Location string: Resource location
Name string: Resource name
ProvisioningState string: Provisioning state of the resource.
Sku SkuResponse: 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.
Status EnvironmentStatusResponse: An object that represents the status of the environment, and its internal state in the Time Series Insights service.
Type string: Resource type
PartitionKeyProperties []TimeSeriesIdPropertyResponse: The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.
StorageLimitExceededBehavior string: 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.
Tags map[string]string: Resource tags

creationTime String: The time the resource was created.
dataAccessFqdn String: 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.
dataAccessId String: An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
dataRetentionTime String: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
id String: Resource Id
location String: Resource location
name String: Resource name
provisioningState String: Provisioning state of the resource.
sku SkuResponse: 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.
status EnvironmentStatusResponse: An object that represents the status of the environment, and its internal state in the Time Series Insights service.
type String: Resource type
partitionKeyProperties List<TimeSeriesIdPropertyResponse>: The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.
storageLimitExceededBehavior String: 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.
tags Map<String,String>: Resource tags

creationTime string: The time the resource was created.
dataAccessFqdn string: 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.
dataAccessId string: An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
dataRetentionTime string: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
id string: Resource Id
location string: Resource location
name string: Resource name
provisioningState string: Provisioning state of the resource.
sku SkuResponse: 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.
status EnvironmentStatusResponse: An object that represents the status of the environment, and its internal state in the Time Series Insights service.
type string: Resource type
partitionKeyProperties TimeSeriesIdPropertyResponse[]: The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.
storageLimitExceededBehavior string: 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.
tags {[key: string]: string}: Resource tags

creation_time str: The time the resource was created.
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.
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_retention_time str: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
id str: Resource Id
location str: Resource location
name str: Resource name
provisioning_state str: Provisioning state of the resource.
sku SkuResponse: 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.
status EnvironmentStatusResponse: An object that represents the status of the environment, and its internal state in the Time Series Insights service.
type str: Resource type
partition_key_properties Sequence[TimeSeriesIdPropertyResponse]: 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_exceeded_behavior str: 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.
tags Mapping[str, str]: Resource tags

creationTime String: The time the resource was created.
dataAccessFqdn String: 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.
dataAccessId String: An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
dataRetentionTime String: ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.
id String: Resource Id
location String: Resource location
name String: Resource name
provisioningState String: Provisioning state of the resource.
sku 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.
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
partitionKeyProperties List<Property Map>: The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.
storageLimitExceededBehavior String: 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.
tags Map<String>: Resource tags

Supporting Types

EnvironmentStateDetailsResponse

Code string: Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases.
Message string: A message that describes the state in detail.

Code string: Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases.
Message string: A message that describes the state in detail.

code String: Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases.
message String: A message that describes the state in detail.

code string: Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases.
message string: A message that describes the state in detail.

code str: Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases.
message str: A message that describes the state in detail.

code String: Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases.
message String: A message that describes the state in detail.

EnvironmentStatusResponse

Ingress Pulumi.AzureNative.TimeSeriesInsights.Inputs.IngressEnvironmentStatusResponse: An object that represents the status of ingress on an environment.
WarmStorage Pulumi.AzureNative.TimeSeriesInsights.Inputs.WarmStorageEnvironmentStatusResponse: An object that represents the status of warm storage on an environment.

Ingress IngressEnvironmentStatusResponse: An object that represents the status of ingress on an environment.
WarmStorage WarmStorageEnvironmentStatusResponse: An object that represents the status of warm storage on an environment.

ingress IngressEnvironmentStatusResponse: An object that represents the status of ingress on an environment.
warmStorage WarmStorageEnvironmentStatusResponse: An object that represents the status of warm storage on an environment.

ingress IngressEnvironmentStatusResponse: An object that represents the status of ingress on an environment.
warmStorage WarmStorageEnvironmentStatusResponse: An object that represents the status of warm storage on an environment.

ingress IngressEnvironmentStatusResponse: An object that represents the status of ingress on an environment.
warm_storage WarmStorageEnvironmentStatusResponse: An object that represents the status of warm storage on an environment.

ingress Property Map: An object that represents the status of ingress on an environment.
warmStorage Property Map: An object that represents the status of warm storage on an environment.

IngressEnvironmentStatusResponse

StateDetails Pulumi.AzureNative.TimeSeriesInsights.Inputs.EnvironmentStateDetailsResponse: 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"

StateDetails EnvironmentStateDetailsResponse: 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"

stateDetails EnvironmentStateDetailsResponse: 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"

stateDetails EnvironmentStateDetailsResponse: 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 EnvironmentStateDetailsResponse: 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"

stateDetails 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"

SkuResponse

Capacity 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 string: The name of this SKU.

Capacity 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 string: The name of this SKU.

capacity Integer: 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 String: The name of this SKU.

capacity 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 string: The name of this SKU.

capacity 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 str: The name of this SKU.

capacity 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 String: The name of this SKU.

TimeSeriesIdPropertyResponse

Name string: The name of the property.
Type string: The type of the property.

Name string: The name of the property.
Type string: The type of the property.

name String: The name of the property.
type String: The type of the property.

name string: The name of the property.
type string: The type of the property.

name str: The name of the property.
type str: The type of the property.

name String: The name of the property.
type String: The type of the property.

WarmStorageEnvironmentStatusResponse

CurrentCount 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
MaxCount 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".

CurrentCount 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
MaxCount 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".

currentCount 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
maxCount 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".

currentCount 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
maxCount 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".

currentCount 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
maxCount 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".

Package Details

Repository: azure-native-v2 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native-v2.timeseriesinsights.getGen1Environment

On this page

On this page

Using getGen1Environment

getGen1Environment Result

Supporting Types

EnvironmentStateDetailsResponse

EnvironmentStatusResponse

IngressEnvironmentStatusResponse

SkuResponse

TimeSeriesIdPropertyResponse

WarmStorageEnvironmentStatusResponse

Package Details

On this page

On this page