你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Environments - Get

服务:: Time Series Insights

API 版本:: 2020-05-15

获取具有指定订阅和资源组中指定名称的环境。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}?api-version=2020-05-15

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
environmentName	path	True	string	与指定资源组关联的时序见解环境的名称。
resourceGroupName	path	True	string	Azure 资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要用于客户端请求的 API 的版本。
$expand	query		string	设置 $expand=status 将包括时序见解服务中环境内部服务的状态。

响应

名称	类型	说明
200 OK	EnvironmentResource: Gen1EnvironmentResource Gen2EnvironmentResource	已成功检索环境定义，并且位于响应中。如果要轮询预配或缩放操作的完成情况，可以通过 provisioningState 属性检查其状态。
Other Status Codes	CloudError	HTTP 404（找不到）：找不到订阅、资源组或环境。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

EnvironmentsGet

示例请求

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


/**
 * Samples for Environments GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/
     * EnvironmentsGet.json
     */
    /**
     * Sample code: EnvironmentsGet.
     * 
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void environmentsGet(com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager.environments().getByResourceGroupWithResponse("rg1", "env1", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armtimeseriesinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsGet.json
func ExampleEnvironmentsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtimeseriesinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEnvironmentsClient().Get(ctx, "rg1", "env1", &armtimeseriesinsights.EnvironmentsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armtimeseriesinsights.EnvironmentsClientGetResponse{
	// 	                            EnvironmentResourceClassification: &armtimeseriesinsights.Gen1EnvironmentResource{
	// 		Name: to.Ptr("env1"),
	// 		Type: to.Ptr("Microsoft.TimeSeriesInsights/Environments"),
	// 		ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1"),
	// 		Location: to.Ptr("West US"),
	// 		Tags: map[string]*string{
	// 		},
	// 		Kind: to.Ptr(armtimeseriesinsights.EnvironmentResourceKindGen1),
	// 		SKU: &armtimeseriesinsights.SKU{
	// 			Name: to.Ptr(armtimeseriesinsights.SKUNameS1),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 		Properties: &armtimeseriesinsights.Gen1EnvironmentResourceProperties{
	// 			CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-18T19:20:33.228Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armtimeseriesinsights.ProvisioningStateSucceeded),
	// 			DataRetentionTime: to.Ptr("P31D"),
	// 			PartitionKeyProperties: []*armtimeseriesinsights.TimeSeriesIDProperty{
	// 				{
	// 					Name: to.Ptr("DeviceId1"),
	// 					Type: to.Ptr(armtimeseriesinsights.PropertyTypeString),
	// 			}},
	// 		},
	// 	},
	// 	                        }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

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

定义

名称	说明
CloudError	包含有关 API 错误的信息。
CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
EnvironmentStateDetails	一个对象，其中包含有关环境状态的详细信息。
EnvironmentStatus	一个对象，表示环境的状态及其在时序见解服务中的内部状态。
Gen1EnvironmentResource	环境是一组可用于查询的时序数据，是顶级 Azure 时序见解资源。第 1 代环境具有数据保留限制。
Gen2EnvironmentResource	环境是一组可用于查询的时序数据，是顶级 Azure 时序见解资源。第 2 代环境没有设置数据保留限制。
Gen2StorageConfigurationOutput	存储配置提供有关用于存储环境数据的客户存储帐户的非机密连接详细信息。
IngressEnvironmentStatus	一个对象，表示环境中入口的状态。
IngressState	此字符串表示环境中入口作的状态。它可以为“Disabled”、“Ready”、“Running”、“Paused”或“Unknown”
PropertyType	属性的类型。
ProvisioningState	资源的预配状态。
Sku	SKU 确定环境类型（第 1 代（S1 或 S2）或 Gen2（L1）。对于 Gen1 环境，SKU 确定环境的容量、入口率和计费费率。
SkuName	此 SKU 的名称。
StorageLimitExceededBehavior	超出环境容量时，时序见解服务应采用的行为。如果指定了“PauseIngress”，则不会从事件源读取新事件。如果指定了“PurgeOldData”，则新事件将继续读取，旧事件将从环境中删除。默认行为为 PurgeOldData。
TimeSeriesIdProperty	时序 ID 可以具有的属性的结构。环境可以有多个此类属性。
WarmStorageEnvironmentStatus	一个对象，表示环境中暖存储的状态。
WarmStoragePropertiesState	此字符串表示暖存储属性使用情况的状态。可以是“确定”、“错误”、“未知”。
WarmStoreConfigurationProperties	暖存储配置提供了创建暖存储缓存的详细信息，该缓存将保留环境数据的副本，以便更快地进行查询。

CloudError

Object

包含有关 API 错误的信息。

名称	类型	说明
error	CloudErrorBody	描述具有错误代码和消息的特定 API 错误。

CloudErrorBody

Object

描述具有错误代码和消息的特定 API 错误。

名称	类型	说明
code	string	比 HTTP 状态代码更准确地描述错误条件的错误代码。可用于以编程方式处理特定错误案例。
details	CloudErrorBody[]	包含与此错误相关的嵌套错误。
message	string	详细说明错误并提供调试信息的消息。
target	string	特定错误的目标（例如，错误中属性的名称）。

EnvironmentStateDetails

Object

一个对象，其中包含有关环境状态的详细信息。

名称	类型	说明
code	string	包含表示环境处于特定状态的原因的代码。可用于以编程方式处理特定情况。
message	string	详细描述状态的消息。

EnvironmentStatus

Object

一个对象，表示环境的状态及其在时序见解服务中的内部状态。

名称	类型	说明
ingress	IngressEnvironmentStatus	一个对象，表示环境中入口的状态。
warmStorage	WarmStorageEnvironmentStatus	一个对象，表示环境中暖存储的状态。

Gen1EnvironmentResource

Object

环境是一组可用于查询的时序数据，是顶级 Azure 时序见解资源。第 1 代环境具有数据保留限制。

名称	类型	说明
creationTime	string (date-time)	创建资源的时间。
id	string	资源 ID
kind	string: Gen1	环境的类型。
location	string	资源位置
name	string	资源名称
properties.dataAccessFqdn	string	用于访问环境数据的完全限定域名，例如查询环境的事件或上传环境的引用数据。
properties.dataAccessId	string (uuid)	用于访问环境数据的 ID，例如查询环境的事件或上传环境的引用数据。
properties.dataRetentionTime	string (duration)	ISO8601时间跨度，指定环境事件可用于查询的最小天数。
properties.partitionKeyProperties	TimeSeriesIdProperty[]	将用于对环境中的数据进行分区的事件属性列表。目前，仅支持单个分区键属性。
properties.status	EnvironmentStatus	一个对象，表示环境的状态及其在时序见解服务中的内部状态。
properties.storageLimitExceededBehavior	StorageLimitExceededBehavior	超出环境容量时，时序见解服务应采用的行为。如果指定了“PauseIngress”，则不会从事件源读取新事件。如果指定了“PurgeOldData”，则新事件将继续读取，旧事件将从环境中删除。默认行为为 PurgeOldData。
provisioningState	ProvisioningState	资源的预配状态。
sku	Sku	SKU 确定环境类型（第 1 代（S1 或 S2）或 Gen2（L1）。对于 Gen1 环境，SKU 确定环境的容量、入口率和计费费率。
tags	object	资源标记
type	string	资源类型

Gen2EnvironmentResource

Object

环境是一组可用于查询的时序数据，是顶级 Azure 时序见解资源。第 2 代环境没有设置数据保留限制。

名称	类型	说明
creationTime	string (date-time)	创建资源的时间。
id	string	资源 ID
kind	string: Gen2	环境的类型。
location	string	资源位置
name	string	资源名称
properties.dataAccessFqdn	string	用于访问环境数据的完全限定域名，例如查询环境的事件或上传环境的引用数据。
properties.dataAccessId	string (uuid)	用于访问环境数据的 ID，例如查询环境的事件或上传环境的引用数据。
properties.status	EnvironmentStatus	一个对象，表示环境的状态及其在时序见解服务中的内部状态。
properties.storageConfiguration	Gen2StorageConfigurationOutput	存储配置提供连接详细信息，允许时序见解服务连接到用于存储环境数据的客户存储帐户。
properties.timeSeriesIdProperties	TimeSeriesIdProperty[]	用于定义环境的时序 ID 的事件属性列表。
properties.warmStoreConfiguration	WarmStoreConfigurationProperties	暖存储配置提供了创建暖存储缓存的详细信息，该缓存将保留环境数据的副本，以便更快地进行查询。
provisioningState	ProvisioningState	资源的预配状态。
sku	Sku	SKU 确定环境类型（第 1 代（S1 或 S2）或 Gen2（L1）。对于 Gen1 环境，SKU 确定环境的容量、入口率和计费费率。
tags	object	资源标记
type	string	资源类型

Gen2StorageConfigurationOutput

Object

存储配置提供有关用于存储环境数据的客户存储帐户的非机密连接详细信息。

名称	类型	说明
accountName	string	将保存环境的 Gen2 数据的存储帐户的名称。

IngressEnvironmentStatus

Object

一个对象，表示环境中入口的状态。

名称	类型	说明
state	IngressState	此字符串表示环境中入口作的状态。它可以为“Disabled”、“Ready”、“Running”、“Paused”或“Unknown”
stateDetails	EnvironmentStateDetails	一个对象，其中包含有关环境状态的详细信息。

IngressState

枚举

此字符串表示环境中入口作的状态。它可以为“Disabled”、“Ready”、“Running”、“Paused”或“Unknown”

值	说明
Disabled
Ready
Running
Paused
Unknown

PropertyType

枚举

属性的类型。

值	说明
String

ProvisioningState

枚举

资源的预配状态。

值	说明
Accepted
Creating
Updating
Succeeded
Failed
Deleting

Sku

Object

SKU 确定环境类型（第 1 代（S1 或 S2）或 Gen2（L1）。对于 Gen1 环境，SKU 确定环境的容量、入口率和计费费率。

名称	类型	说明
capacity	integer (int32) minimum: 1 maximum: 10	SKU 的容量。对于 Gen1 环境，此值可以更改为支持在创建环境后横向扩展环境。
name	SkuName	此 SKU 的名称。

SkuName

枚举

此 SKU 的名称。

值	说明
S1
S2
P1
L1

StorageLimitExceededBehavior

枚举

超出环境容量时，时序见解服务应采用的行为。如果指定了“PauseIngress”，则不会从事件源读取新事件。如果指定了“PurgeOldData”，则新事件将继续读取，旧事件将从环境中删除。默认行为为 PurgeOldData。

值	说明
PurgeOldData
PauseIngress

TimeSeriesIdProperty

Object

时序 ID 可以具有的属性的结构。环境可以有多个此类属性。

名称	类型	说明
name	string	属性的名称。
type	PropertyType	属性的类型。

WarmStorageEnvironmentStatus

Object

一个对象，表示环境中暖存储的状态。

名称	类型	说明
propertiesUsage.state	WarmStoragePropertiesState	此字符串表示暖存储属性使用情况的状态。可以是“确定”、“错误”、“未知”。
propertiesUsage.stateDetails.currentCount	integer (int32) minimum: 1 maximum: 10	一个值，表示环境用于 S1/S2 SKU 的属性数，以及用于 PAYG SKU 的暖存储使用的属性数
propertiesUsage.stateDetails.maxCount	integer (int32) minimum: 1 maximum: 10	一个值，表示 S1/S2 SKU 的环境允许的最大属性数，以及 PAYG SKU 暖存储允许的最大属性数。

WarmStoragePropertiesState

枚举

此字符串表示暖存储属性使用情况的状态。可以是“确定”、“错误”、“未知”。

值	说明
Ok
Error
Unknown

WarmStoreConfigurationProperties

Object

暖存储配置提供了创建暖存储缓存的详细信息，该缓存将保留环境数据的副本，以便更快地进行查询。

名称	类型	说明
dataRetention	string (duration)	ISO8601时间跨度，指定环境事件将可用于从暖存储进行查询的天数。

通过

Environments - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

EnvironmentsGet

示例请求

示例响应

定义

CloudError

CloudErrorBody

EnvironmentStateDetails

EnvironmentStatus

Gen1EnvironmentResource

Gen2EnvironmentResource

Gen2StorageConfigurationOutput

IngressEnvironmentStatus

IngressState

PropertyType

ProvisioningState

Sku

SkuName

StorageLimitExceededBehavior

TimeSeriesIdProperty

WarmStorageEnvironmentStatus

WarmStoragePropertiesState

WarmStoreConfigurationProperties