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

Environments - List By Resource Group

列出与订阅和指定资源组内关联的所有可用环境。

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

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

Azure 资源组的名称。

subscriptionId
path True
  • string

Azure 订阅 ID。

api-version
query True
  • string

要用于客户端请求的 API 的版本。

响应

Name Type Description
200 OK

成功返回的环境。

Other Status Codes

HTTP 404 (找不到) :找不到订阅或资源组。

安全性

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 模拟用户帐户

示例

EnvironmentsByResourceGroup

Sample Request

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

Sample Response

{
  "value": [
    {
      "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"
      },
      "sku": {
        "name": "S1",
        "capacity": 1
      }
    }
  ]
}

定义

CloudError

包含有关 API 错误的信息。

CloudErrorBody

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

EnvironmentListResponse

列表环境操作的响应。

EnvironmentStateDetails

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

EnvironmentStatus

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

Gen1EnvironmentResource

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

Gen2EnvironmentResource

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

Gen2StorageConfigurationOutput

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

IngressEnvironmentStatus

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

IngressState

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

PropertyType

属性的类型。

ProvisioningState

资源的预配状态。

Sku

SKU 确定环境类型,即 Gen1 (S1 或 S2) 或 Gen2 (L1) 。 对于 Gen1 环境,SKU 确定环境的容量、入口率和计费费率。

SkuName

此 SKU 的名称。

StorageLimitExceededBehavior

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

TimeSeriesIdProperty

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

WarmStorageEnvironmentStatus

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

WarmStoragePropertiesState

此字符串表示暖存储属性使用情况的状态。 可以是“Ok”、“Error”、“Unknown”。

WarmStoreConfigurationProperties

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

CloudError

包含有关 API 错误的信息。

Name Type Description
error

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

CloudErrorBody

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

Name Type Description
code
  • string

描述错误条件的错误代码比 HTTP 状态代码更精确。 可用于以编程方式处理特定错误案例。

details

包含与此错误相关的嵌套错误。

message
  • string

详细说明错误并提供调试信息的消息。

target
  • string

特定错误的目标 (例如,错误) 中属性的名称。

EnvironmentListResponse

列表环境操作的响应。

Name Type Description
value EnvironmentResource[]:

列表环境操作的结果。

EnvironmentStateDetails

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

Name Type Description
code
  • string

包含表示环境处于特定状态的原因的代码。 可用于以编程方式处理特定情况。

message
  • string

详细描述状态的消息。

EnvironmentStatus

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

Name Type Description
ingress

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

warmStorage

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

Gen1EnvironmentResource

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

Name Type Description
creationTime
  • string

创建资源的时间。

id
  • string

资源 ID

kind string:
  • Gen1

环境的类型。

location
  • string

资源位置

name
  • string

资源名称

properties.dataAccessFqdn
  • string

用于访问环境数据的完全限定域名,例如查询环境的事件或上传环境的引用数据。

properties.dataAccessId
  • string

用于访问环境数据的 ID,例如查询环境的事件或上传环境的引用数据。

properties.dataRetentionTime
  • string

指定环境事件可用于查询的最小天数的 ISO8601 时间跨度。

properties.partitionKeyProperties

用于对环境中的数据进行分区的事件属性列表。 目前,仅支持单个分区键属性。

properties.status

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

properties.storageLimitExceededBehavior

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

provisioningState

资源的预配状态。

sku

SKU 确定环境类型,即 Gen1 (S1 或 S2) 或 Gen2 (L1) 。 对于 Gen1 环境,SKU 确定环境的容量、入口率和计费费率。

tags
  • object

资源标记

type
  • string

资源类型

Gen2EnvironmentResource

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

Name Type Description
creationTime
  • string

创建资源的时间。

id
  • string

资源 ID

kind string:
  • Gen2

环境的类型。

location
  • string

资源位置

name
  • string

资源名称

properties.dataAccessFqdn
  • string

用于访问环境数据的完全限定域名,例如查询环境的事件或上传环境的引用数据。

properties.dataAccessId
  • string

用于访问环境数据的 ID,例如查询环境的事件或上传环境的引用数据。

properties.status

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

properties.storageConfiguration

存储配置提供连接详细信息,允许时序Insights服务连接到用于存储环境数据的客户存储帐户。

properties.timeSeriesIdProperties

用于定义环境的时序 ID 的事件属性列表。

properties.warmStoreConfiguration

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

provisioningState

资源的预配状态。

sku

SKU 确定环境类型,即 Gen1 (S1 或 S2) 或 Gen2 (L1) 。 对于 Gen1 环境,SKU 确定环境的容量、入口率和计费费率。

tags
  • object

资源标记

type
  • string

资源类型

Gen2StorageConfigurationOutput

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

Name Type Description
accountName
  • string

将保存环境的 Gen2 数据的存储帐户的名称。

IngressEnvironmentStatus

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

Name Type Description
state

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

stateDetails

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

IngressState

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

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

PropertyType

属性的类型。

Name Type Description
String
  • string

ProvisioningState

资源的预配状态。

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

Sku

SKU 确定环境类型,即 Gen1 (S1 或 S2) 或 Gen2 (L1) 。 对于 Gen1 环境,SKU 确定环境的容量、入口率和计费费率。

Name Type Description
capacity
  • integer

SKU 的容量。 对于 Gen1 环境,此值可以在创建后支持横向扩展环境。

name

此 SKU 的名称。

SkuName

此 SKU 的名称。

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

StorageLimitExceededBehavior

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

Name Type Description
PauseIngress
  • string
PurgeOldData
  • string

TimeSeriesIdProperty

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

Name Type Description
name
  • string

属性的名称。

type

属性的类型。

WarmStorageEnvironmentStatus

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

Name Type Description
propertiesUsage.state

此字符串表示暖存储属性使用情况的状态。 可以是“Ok”、“Error”、“Unknown”。

propertiesUsage.stateDetails.currentCount
  • integer

一个值,表示环境用于 S1/S2 SKU 的属性数,以及 PAYG SKU 的暖Microsoft Store使用的属性数

propertiesUsage.stateDetails.maxCount
  • integer

一个值,表示 S1/S2 SKU 的环境使用的最大属性数,以及 PAYG SKU Microsoft Store允许的最大属性数。

WarmStoragePropertiesState

此字符串表示暖存储属性使用情况的状态。 可以是“Ok”、“Error”、“Unknown”。

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

WarmStoreConfigurationProperties

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

Name Type Description
dataRetention
  • string

ISO8601 时间跨度,指定环境事件可用于从暖存储进行查询的天数。