你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Environments - List By Resource Group
Lists与订阅关联的所有可用环境以及指定资源组内的环境。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments?api-version=2020-05-15
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
Azure 资源组的名称。 |
subscription
|
path | True |
string |
Azure 订阅 ID。 |
api-version
|
query | True |
string |
要与客户端请求一起使用的 API 的版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
已成功返回环境。 |
|
Other Status Codes |
HTTP 404 (找不到) :找不到订阅或资源组。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
EnvironmentsByResourceGroup
Sample Request
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
}
}
]
}
定义
名称 | 说明 |
---|---|
Cloud |
包含有关 API 错误的信息。 |
Cloud |
描述具有错误代码和消息的特定 API 错误。 |
Environment |
列出环境操作的响应。 |
Environment |
一个 对象,其中包含有关环境状态的详细信息。 |
Environment |
一个 对象,表示环境的状态及其在时序见解服务中的内部状态。 |
Gen1Environment |
环境是一组可供查询的时序数据,是资源Azure 时序见解顶级。 Gen1 环境具有数据保留限制。 |
Gen2Environment |
环境是一组可供查询的时序数据,是资源Azure 时序见解顶级。 Gen2 环境没有设置数据保留限制。 |
Gen2Storage |
存储配置提供有关用于存储环境数据的客户存储帐户的非机密连接详细信息。 |
Ingress |
一个 对象,表示环境中的入口状态。 |
Ingress |
此字符串表示环境中入口操作的状态。 它可以是“已禁用”、“就绪”、“正在运行”、“已暂停”或“未知” |
Property |
属性的类型。 |
Provisioning |
资源的预配状态。 |
Sku |
SKU 确定环境类型,无论是 Gen1 (S1 或 S2) 还是 Gen2 (L1) 。 对于 Gen1 环境,SKU 确定环境的容量、入口率和计费费率。 |
Sku |
此 SKU 的名称。 |
Storage |
时序见解服务在超出环境的容量时应采取的行为。 如果指定了“PauseIngress”,则不会从事件源中读取新事件。 如果指定了“PurgeOldData”,将继续读取新事件,并从环境中删除旧事件。 默认行为为 PurgeOldData。 |
Time |
时序 ID 可以具有的属性的结构。 一个环境可以有多个此类属性。 |
Warm |
一个 对象,表示环境中暖存储的状态。 |
Warm |
此字符串表示暖存储属性使用情况的状态。 它可以是“确定”、“错误”、“未知”。 |
Warm |
暖存储配置提供了创建暖存储缓存的详细信息,该缓存将保留可用于更快查询的环境数据的副本。 |
CloudError
包含有关 API 错误的信息。
名称 | 类型 | 说明 |
---|---|---|
error |
描述具有错误代码和消息的特定 API 错误。 |
CloudErrorBody
描述具有错误代码和消息的特定 API 错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
一个错误代码,它比 HTTP 状态代码更准确地描述错误条件。 可用于以编程方式处理特定错误情况。 |
details |
包含与此错误相关的嵌套错误。 |
|
message |
string |
一条消息,详细说明错误并提供调试信息。 |
target |
string |
特定错误的目标 (例如,错误) 中的属性的名称。 |
EnvironmentListResponse
列出环境操作的响应。
名称 | 类型 | 说明 |
---|---|---|
value | EnvironmentResource[]: |
列出环境操作的结果。 |
EnvironmentStateDetails
一个 对象,其中包含有关环境状态的详细信息。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
包含表示环境处于特定状态的原因的代码。 可用于以编程方式处理特定情况。 |
message |
string |
详细描述状态的消息。 |
EnvironmentStatus
一个 对象,表示环境的状态及其在时序见解服务中的内部状态。
名称 | 类型 | 说明 |
---|---|---|
ingress |
一个 对象,表示环境中的入口状态。 |
|
warmStorage |
一个 对象,表示环境中暖存储的状态。 |
Gen1EnvironmentResource
环境是一组可供查询的时序数据,是资源Azure 时序见解顶级。 Gen1 环境具有数据保留限制。
名称 | 类型 | 说明 |
---|---|---|
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 |
一个 对象,表示环境的状态及其在时序见解服务中的内部状态。 |
|
properties.storageLimitExceededBehavior |
时序见解服务在超出环境的容量时应采取的行为。 如果指定了“PauseIngress”,则不会从事件源中读取新事件。 如果指定了“PurgeOldData”,将继续读取新事件,并从环境中删除旧事件。 默认行为为 PurgeOldData。 |
|
provisioningState |
资源的预配状态。 |
|
sku |
SKU 确定环境类型,无论是 Gen1 (S1 或 S2) 还是 Gen2 (L1) 。 对于 Gen1 环境,SKU 确定环境的容量、入口率和计费费率。 |
|
tags |
object |
资源标记 |
type |
string |
资源类型 |
Gen2EnvironmentResource
环境是一组可供查询的时序数据,是资源Azure 时序见解顶级。 Gen2 环境没有设置数据保留限制。
名称 | 类型 | 说明 |
---|---|---|
creationTime |
string |
创建资源的时间。 |
id |
string |
资源 ID |
kind |
string:
Gen2 |
环境的种类。 |
location |
string |
资源位置 |
name |
string |
资源名称 |
properties.dataAccessFqdn |
string |
用于访问环境数据的完全限定域名,例如,用于查询环境的事件或上传环境的引用数据。 |
properties.dataAccessId |
string |
用于访问环境数据的 ID,例如,用于查询环境的事件或上传环境的引用数据。 |
properties.status |
一个 对象,表示环境的状态及其在时序见解服务中的内部状态。 |
|
properties.storageConfiguration |
存储配置提供连接详细信息,使时序见解服务能够连接到用于存储环境数据的客户存储帐户。 |
|
properties.timeSeriesIdProperties |
用于定义环境时序 ID 的事件属性列表。 |
|
properties.warmStoreConfiguration |
暖存储配置提供了创建暖存储缓存的详细信息,该缓存将保留可用于更快查询的环境数据的副本。 |
|
provisioningState |
资源的预配状态。 |
|
sku |
SKU 确定环境类型,无论是 Gen1 (S1 或 S2) 还是 Gen2 (L1) 。 对于 Gen1 环境,SKU 确定环境的容量、入口率和计费费率。 |
|
tags |
object |
资源标记 |
type |
string |
资源类型 |
Gen2StorageConfigurationOutput
存储配置提供有关用于存储环境数据的客户存储帐户的非机密连接详细信息。
名称 | 类型 | 说明 |
---|---|---|
accountName |
string |
将保存环境的 Gen2 数据的存储帐户的名称。 |
IngressEnvironmentStatus
一个 对象,表示环境中的入口状态。
名称 | 类型 | 说明 |
---|---|---|
state |
此字符串表示环境中入口操作的状态。 它可以是“已禁用”、“就绪”、“正在运行”、“已暂停”或“未知” |
|
stateDetails |
一个 对象,其中包含有关环境状态的详细信息。 |
IngressState
此字符串表示环境中入口操作的状态。 它可以是“已禁用”、“就绪”、“正在运行”、“已暂停”或“未知”
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Paused |
string |
|
Ready |
string |
|
Running |
string |
|
Unknown |
string |
PropertyType
属性的类型。
名称 | 类型 | 说明 |
---|---|---|
String |
string |
ProvisioningState
资源的预配状态。
名称 | 类型 | 说明 |
---|---|---|
Accepted |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
Sku
SKU 确定环境类型,无论是 Gen1 (S1 或 S2) 还是 Gen2 (L1) 。 对于 Gen1 环境,SKU 确定环境的容量、入口率和计费费率。
名称 | 类型 | 说明 |
---|---|---|
capacity |
integer |
SKU 的容量。 对于 Gen1 环境,可以更改此值以支持在创建环境后横向扩展环境。 |
name |
此 SKU 的名称。 |
SkuName
此 SKU 的名称。
名称 | 类型 | 说明 |
---|---|---|
L1 |
string |
|
P1 |
string |
|
S1 |
string |
|
S2 |
string |
StorageLimitExceededBehavior
时序见解服务在超出环境的容量时应采取的行为。 如果指定了“PauseIngress”,则不会从事件源中读取新事件。 如果指定了“PurgeOldData”,将继续读取新事件,并从环境中删除旧事件。 默认行为为 PurgeOldData。
名称 | 类型 | 说明 |
---|---|---|
PauseIngress |
string |
|
PurgeOldData |
string |
TimeSeriesIdProperty
时序 ID 可以具有的属性的结构。 一个环境可以有多个此类属性。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
属性的名称。 |
type |
属性的类型。 |
WarmStorageEnvironmentStatus
一个 对象,表示环境中暖存储的状态。
名称 | 类型 | 说明 |
---|---|---|
propertiesUsage.state |
此字符串表示暖存储属性使用情况的状态。 它可以是“确定”、“错误”、“未知”。 |
|
propertiesUsage.stateDetails.currentCount |
integer |
一个 值,该值表示环境用于 S1/S2 SKU 的属性数,以及暖存储用于 PAYG SKU 的属性数 |
propertiesUsage.stateDetails.maxCount |
integer |
一个 值,表示环境允许用于 S1/S2 SKU 的属性的最大数目,以及用于 PAYG SKU 的暖存储允许的最大属性数。 |
WarmStoragePropertiesState
此字符串表示暖存储属性使用情况的状态。 它可以是“确定”、“错误”、“未知”。
名称 | 类型 | 说明 |
---|---|---|
Error |
string |
|
Ok |
string |
|
Unknown |
string |
WarmStoreConfigurationProperties
暖存储配置提供了创建暖存储缓存的详细信息,该缓存将保留可用于更快查询的环境数据的副本。
名称 | 类型 | 说明 |
---|---|---|
dataRetention |
string |
ISO8601时间跨度,指定环境事件可从暖存储中查询的天数。 |