1. Packages
  2. Azure Native
  3. API Docs
  4. timeseriesinsights
  5. getGen2Environment
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.timeseriesinsights.getGen2Environment

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Gets the environment with the specified name in the specified subscription and resource group.

Uses Azure REST API version 2020-05-15.

Using getGen2Environment

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.

function getGen2Environment(args: GetGen2EnvironmentArgs, opts?: InvokeOptions): Promise<GetGen2EnvironmentResult>
function getGen2EnvironmentOutput(args: GetGen2EnvironmentOutputArgs, opts?: InvokeOptions): Output<GetGen2EnvironmentResult>
Copy
def get_gen2_environment(environment_name: Optional[str] = None,
                         expand: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetGen2EnvironmentResult
def get_gen2_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[GetGen2EnvironmentResult]
Copy
func LookupGen2Environment(ctx *Context, args *LookupGen2EnvironmentArgs, opts ...InvokeOption) (*LookupGen2EnvironmentResult, error)
func LookupGen2EnvironmentOutput(ctx *Context, args *LookupGen2EnvironmentOutputArgs, opts ...InvokeOption) LookupGen2EnvironmentResultOutput
Copy

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

public static class GetGen2Environment 
{
    public static Task<GetGen2EnvironmentResult> InvokeAsync(GetGen2EnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetGen2EnvironmentResult> Invoke(GetGen2EnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGen2EnvironmentResult> getGen2Environment(GetGen2EnvironmentArgs args, InvokeOptions options)
public static Output<GetGen2EnvironmentResult> getGen2Environment(GetGen2EnvironmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:timeseriesinsights:getGen2Environment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Time Series Insights environment associated with the specified resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Time Series Insights environment associated with the specified resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Time Series Insights environment associated with the specified resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the Time Series Insights environment associated with the specified resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The name of the Time Series Insights environment associated with the specified resource group.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the Time Series Insights environment associated with the specified resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.

getGen2Environment Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
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.
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.
StorageConfiguration Pulumi.AzureNative.TimeSeriesInsights.Outputs.Gen2StorageConfigurationOutputResponse
The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.
TimeSeriesIdProperties List<Pulumi.AzureNative.TimeSeriesInsights.Outputs.TimeSeriesIdPropertyResponse>
The list of event properties which will be used to define the environment's time series id.
Type string
Resource type
Tags Dictionary<string, string>
Resource tags
WarmStoreConfiguration Pulumi.AzureNative.TimeSeriesInsights.Outputs.WarmStoreConfigurationPropertiesResponse
The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.
AzureApiVersion string
The Azure API version of the resource.
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.
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.
StorageConfiguration Gen2StorageConfigurationOutputResponse
The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.
TimeSeriesIdProperties []TimeSeriesIdPropertyResponse
The list of event properties which will be used to define the environment's time series id.
Type string
Resource type
Tags map[string]string
Resource tags
WarmStoreConfiguration WarmStoreConfigurationPropertiesResponse
The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.
azureApiVersion String
The Azure API version of the resource.
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.
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.
storageConfiguration Gen2StorageConfigurationOutputResponse
The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.
timeSeriesIdProperties List<TimeSeriesIdPropertyResponse>
The list of event properties which will be used to define the environment's time series id.
type String
Resource type
tags Map<String,String>
Resource tags
warmStoreConfiguration WarmStoreConfigurationPropertiesResponse
The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.
azureApiVersion string
The Azure API version of the resource.
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.
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.
storageConfiguration Gen2StorageConfigurationOutputResponse
The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.
timeSeriesIdProperties TimeSeriesIdPropertyResponse[]
The list of event properties which will be used to define the environment's time series id.
type string
Resource type
tags {[key: string]: string}
Resource tags
warmStoreConfiguration WarmStoreConfigurationPropertiesResponse
The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.
azure_api_version str
The Azure API version of the resource.
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.
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.
storage_configuration Gen2StorageConfigurationOutputResponse
The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.
time_series_id_properties Sequence[TimeSeriesIdPropertyResponse]
The list of event properties which will be used to define the environment's time series id.
type str
Resource type
tags Mapping[str, str]
Resource tags
warm_store_configuration WarmStoreConfigurationPropertiesResponse
The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.
azureApiVersion String
The Azure API version of the resource.
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.
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.
storageConfiguration Property Map
The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.
timeSeriesIdProperties List<Property Map>
The list of event properties which will be used to define the environment's time series id.
type String
Resource type
tags Map<String>
Resource tags
warmStoreConfiguration Property Map
The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.

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 This property is required. Pulumi.AzureNative.TimeSeriesInsights.Inputs.IngressEnvironmentStatusResponse
An object that represents the status of ingress on an environment.
WarmStorage This property is required. Pulumi.AzureNative.TimeSeriesInsights.Inputs.WarmStorageEnvironmentStatusResponse
An object that represents the status of warm storage on an environment.
Ingress This property is required. IngressEnvironmentStatusResponse
An object that represents the status of ingress on an environment.
WarmStorage This property is required. WarmStorageEnvironmentStatusResponse
An object that represents the status of warm storage on an environment.
ingress This property is required. IngressEnvironmentStatusResponse
An object that represents the status of ingress on an environment.
warmStorage This property is required. WarmStorageEnvironmentStatusResponse
An object that represents the status of warm storage on an environment.
ingress This property is required. IngressEnvironmentStatusResponse
An object that represents the status of ingress on an environment.
warmStorage This property is required. WarmStorageEnvironmentStatusResponse
An object that represents the status of warm storage on an environment.
ingress This property is required. IngressEnvironmentStatusResponse
An object that represents the status of ingress on an environment.
warm_storage This property is required. WarmStorageEnvironmentStatusResponse
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.
warmStorage This property is required. Property Map
An object that represents the status of warm storage on an environment.

Gen2StorageConfigurationOutputResponse

AccountName This property is required. string
The name of the storage account that will hold the environment's Gen2 data.
AccountName This property is required. string
The name of the storage account that will hold the environment's Gen2 data.
accountName This property is required. String
The name of the storage account that will hold the environment's Gen2 data.
accountName This property is required. string
The name of the storage account that will hold the environment's Gen2 data.
account_name This property is required. str
The name of the storage account that will hold the environment's Gen2 data.
accountName This property is required. String
The name of the storage account that will hold the environment's Gen2 data.

IngressEnvironmentStatusResponse

StateDetails This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 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"

SkuResponse

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
The name of this SKU.
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
The name of this SKU.
capacity This property is required. 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 This property is required. String
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
The name of this SKU.
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. str
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
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".

WarmStoreConfigurationPropertiesResponse

DataRetention This property is required. string
ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.
DataRetention This property is required. string
ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.
dataRetention This property is required. String
ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.
dataRetention This property is required. string
ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.
data_retention This property is required. str
ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.
dataRetention This property is required. String
ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi