Environments - Get

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}?api-version=2018-08-15-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}?$expand={$expand}&api-version=2018-08-15-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Azure Subscription ID.

resourceGroupName
path True
  • string

Name of an Azure Resource group.

environmentName
path True
  • string

The name of the Time Series Insights environment associated with the specified resource group.

$expand
query
  • string

Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

api-version
query True
  • string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK EnvironmentResource:

The environment definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.

Other Status Codes

HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

EnvironmentsGet

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1?api-version=2018-08-15-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1",
  "location": "West US",
  "name": "env1",
  "type": "Microsoft.TimeSeriesInsights/Environments",
  "kind": "Standard",
  "tags": {},
  "properties": {
    "dataRetentionTime": "P31D",
    "provisioningState": "Succeeded",
    "creationTime": "2017-04-18T19:20:33.2288820Z",
    "partitionKeyProperties": [
      {
        "name": "DeviceId1",
        "type": "String"
      }
    ]
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

Definitions

CloudError

Contains information about an API error.

CloudErrorBody

Describes a particular API error with an error code and a message.

EnvironmentStateDetails

An object that contains the details about an environment's state.

EnvironmentStatus

An object that represents the status of the environment, and its internal state in the Time Series Insights service.

IngressEnvironmentStatus

An object that represents the status of ingress on an environment.

IngressState

This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown"

LongTermEnvironmentResource

An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. LongTerm environments do not have set data retention limits.

LongTermStorageConfigurationOutput

The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data.

PropertyType

The type of the property.

ProvisioningState

Provisioning state of the resource.

Sku

The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

SkuName

The name of this SKU.

StandardEnvironmentResource

An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Standard environments have data retention limits.

StorageLimitExceededBehavior

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.

TimeSeriesIdProperty

The structure of the property that a time series id can have. An environment can have multiple such properties.

WarmStorageEnvironmentStatus

An object that represents the status of warm storage on an environment.

WarmStoragePropertiesState

This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".

CloudError

Contains information about an API error.

Name Type Description
error

Describes a particular API error with an error code and a message.

CloudErrorBody

Describes a particular API error with an error code and a message.

Name Type Description
code
  • string

An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.

details

Contains nested errors that are related to this error.

message
  • string

A message that describes the error in detail and provides debugging information.

target
  • string

The target of the particular error (for example, the name of the property in error).

EnvironmentStateDetails

An object that contains the details about an environment's state.

Name Type Description
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.

EnvironmentStatus

An object that represents the status of the environment, and its internal state in the Time Series Insights service.

Name Type Description
ingress

An object that represents the status of ingress on an environment.

warmStorage

An object that represents the status of warm storage on an environment.

IngressEnvironmentStatus

An object that represents the status of ingress on an environment.

Name Type Description
state

This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown"

stateDetails

An object that contains the details about an environment's state.

IngressState

This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown"

Name Type Description
Disabled
  • string
Paused
  • string
Ready
  • string
Running
  • string
Unknown
  • string

LongTermEnvironmentResource

An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. LongTerm environments do not have set data retention limits.

Name Type Description
creationTime
  • string

The time the resource was created.

id
  • string

Resource Id

kind string:
  • LongTerm

The kind of the environment.

location
  • string

Resource location

name
  • string

Resource name

properties.creationTime
  • string

The time the resource was created.

properties.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.

properties.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.

properties.provisioningState

Provisioning state of the resource.

properties.status

An object that represents the status of the environment, and its internal state in the Time Series Insights service.

properties.storageConfiguration

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.

properties.timeSeriesIdProperties

The list of event properties which will be used to define the environment's time series id.

properties.warmStoreConfiguration.dataRetention
  • string

ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.

provisioningState

Provisioning state of the resource.

sku

The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

tags
  • object

Resource tags

type
  • string

Resource type

LongTermStorageConfigurationOutput

The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data.

Name Type Description
accountName
  • string

The name of the storage account that will hold the environment's long term data.

PropertyType

The type of the property.

Name Type Description
String
  • string

ProvisioningState

Provisioning state of the resource.

Name Type Description
Accepted
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

Sku

The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

Name Type Description
capacity
  • integer

The capacity of the sku. For standard environments, this value can be changed to support scale out of environments after they have been created.

name

The name of this SKU.

SkuName

The name of this SKU.

Name Type Description
L1
  • string
P1
  • string
S1
  • string
S2
  • string

StandardEnvironmentResource

An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Standard environments have data retention limits.

Name Type Description
creationTime
  • string

The time the resource was created.

id
  • string

Resource Id

kind string:
  • Standard

The kind of the environment.

location
  • string

Resource location

name
  • string

Resource name

properties.creationTime
  • string

The time the resource was created.

properties.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.

properties.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.

properties.dataRetentionTime
  • string

ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.

properties.partitionKeyProperties

The list of event properties which will be used to partition data in the environment.

properties.provisioningState

Provisioning state of the resource.

properties.status

An object that represents the status of the environment, and its internal state in the Time Series Insights service.

properties.storageLimitExceededBehavior

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.

provisioningState

Provisioning state of the resource.

sku

The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.

tags
  • object

Resource tags

type
  • string

Resource type

StorageLimitExceededBehavior

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.

Name Type Description
PauseIngress
  • string
PurgeOldData
  • string

TimeSeriesIdProperty

The structure of the property that a time series id can have. An environment can have multiple such properties.

Name Type Description
name
  • string

The name of the property.

type

The type of the property.

WarmStorageEnvironmentStatus

An object that represents the status of warm storage on an environment.

Name Type Description
propertiesUsage.state

This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".

propertiesUsage.stateDetails.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

propertiesUsage.stateDetails.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.

WarmStoragePropertiesState

This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown".

Name Type Description
Error
  • string
Ok
  • string
Unknown
  • string