environments

Creates, updates, deletes, gets or lists an environments resource.

Overview

Name	environments
Type	Resource
Id	azure.time_series_insights.environments

Fields

The following fields are returned by SELECT queries:

get

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.

Name	Datatype	Description
kind	string	The kind of the environment.
location	string	The geo-location where the resource lives
sku	object	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.
tags	object	Resource tags.

list_by_resource_group

Environments returned successfully.

Name	Datatype	Description
kind	string	The kind of the environment.
location	string	The geo-location where the resource lives
sku	object	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.
tags	object	Resource tags.

list_by_subscription

Environments returned successfully.

Name	Datatype	Description
kind	string	The kind of the environment.
location	string	The geo-location where the resource lives
sku	object	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.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, environmentName	$expand	Gets the environment with the specified name in the specified subscription and resource group.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the available environments associated with the subscription and within the specified resource group.
list_by_subscription	select	subscriptionId		Lists all the available environments within a subscription, irrespective of the resource groups.
create_or_update	insert	subscriptionId, resourceGroupName, environmentName, data__kind, data__sku		Create or update an environment in the specified subscription and resource group.
update	update	subscriptionId, resourceGroupName, environmentName, data__kind		Updates the environment with the specified name in the specified subscription and resource group.
delete	delete	subscriptionId, resourceGroupName, environmentName		Deletes the environment with the specified name in the specified subscription and resource group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environmentName	string	The name of the Time Series Insights environment associated with the specified resource group.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$expand	string	Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

SELECT examples

get

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

SELECT
kind,
location,
sku,
tags
FROM azure.time_series_insights.environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND environmentName = '{{ environmentName }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Lists all the available environments associated with the subscription and within the specified resource group.

SELECT
kind,
location,
sku,
tags
FROM azure.time_series_insights.environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all the available environments within a subscription, irrespective of the resource groups.

SELECT
kind,
location,
sku,
tags
FROM azure.time_series_insights.environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update an environment in the specified subscription and resource group.

INSERT INTO azure.time_series_insights.environments (
data__kind,
data__sku,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
environmentName
)
SELECT 
'{{ kind }}' /* required */,
'{{ sku }}' /* required */,
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ environmentName }}'
RETURNING
kind,
location,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: environments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the environments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the environments resource.
    - name: environmentName
      value: string
      description: Required parameter for the environments resource.
    - name: kind
      value: string
      description: |
        The kind of the environment.
      valid_values: ['Gen1', 'Gen2']
    - name: sku
      value: object
      description: |
        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.
    - name: location
      value: string
      description: |
        The location of the resource.
    - name: tags
      value: object
      description: |
        Key-value pairs of additional properties for the resource.

UPDATE examples

update

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

UPDATE azure.time_series_insights.environments
SET 
data__kind = '{{ kind }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND environmentName = '{{ environmentName }}' --required
AND data__kind = '{{ kind }}' --required
RETURNING
kind,
location,
sku,
tags;

DELETE examples

delete

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

DELETE FROM azure.time_series_insights.environments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND environmentName = '{{ environmentName }}' --required
;