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

Clusters - List By Resource Group

  • 参考
Service:
Stream Analytics
API Version:
2020-03-01

Lists给定资源组中的所有群集。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters?api-version=2020-03-01

URI 参数

名称 在 必需 类型 说明
resourceGroupName
 path True

string

资源组的名称。 此名称不区分大小写。

Regex pattern: ^[-\w\._\(\)]+$
subscriptionId
 path True

string

目标订阅的 ID。
api-version
 query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

ClusterListResult

已成功列出指定资源组下的群集。
Other Status Codes

Error

错误。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

List clusters in resource group

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters?api-version=2020-03-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster",
      "name": "An Example Cluster",
      "type": "Microsoft.StreamAnalytics/clusters",
      "location": "Central US",
      "tags": {
        "key": "value"
      },
      "sku": {
        "name": "Default",
        "capacity": 96
      },
      "properties": {
        "createdDate": "2020-01-25T01:00:00Z",
        "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839",
        "provisioningState": "Succeeded",
        "capacityAllocated": 48,
        "capacityAssigned": 96
      },
      "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C"
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/ADifferentStreamingCluster",
      "name": "A Different Cluster",
      "type": "Microsoft.StreamAnalytics/clusters",
      "location": "Central US",
      "tags": {
        "key": "value"
      },
      "sku": {
        "name": "Default",
        "capacity": 96
      },
      "properties": {
        "createdDate": "2020-01-25T01:00:00Z",
        "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839",
        "provisioningState": "Succeeded",
        "capacityAllocated": 48,
        "capacityAssigned": 96
      },
      "etag": "G97C0C81-D5B1-451D-AFC8-0B42D4729B8C"
    }
  ],
  "nextLink": null
}

定义

名称 说明
Cluster

流分析群集对象
ClusterListResult

由“列表”操作填充的群集列表。
ClusterProvisioningState

群集预配的状态。 三种终端状态为：成功、失败和取消
ClusterSku

群集的 SKU。 这决定了群集的大小/容量。 在 PUT (CreateOrUpdate) 请求上是必需的。
ClusterSkuName

指定群集的 SKU 名称。 在 PUT (CreateOrUpdate) 请求上是必需的。
Error

常见错误表示形式。

Cluster

流分析群集对象

名称 类型 说明
etag

string

群集的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行写入操作，实现乐观并发。
id

string

资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

资源所在的地理位置
name

string

资源的名称
properties.capacityAllocated

integer

表示群集上当前使用的流单元数。
properties.capacityAssigned

integer

表示与群集关联的所有流作业的 SU 之和。 如果所有作业都在运行，则这是分配的容量。
properties.clusterId

string

群集的唯一标识符。
properties.createdDate

string

创建此群集的日期。
properties.provisioningState

ClusterProvisioningState

群集预配的状态。 三种终端状态为：成功、失败和取消
sku

ClusterSku

群集的 SKU。 这决定了群集的大小/容量。 在 PUT (CreateOrUpdate) 请求上是必需的。
tags

object

资源标记。
type

string

资源类型。 Ex-Microsoft.Compute/virtualMachines 或 Microsoft.Storage/storageAccounts。

ClusterListResult

由“列表”操作填充的群集列表。

名称 类型 说明
nextLink

string

用于提取下一组群集的 URL。
value

Cluster[]

群集的列表。

ClusterProvisioningState

群集预配的状态。 三种终端状态为：成功、失败和取消

名称 类型 说明
Canceled

string

群集预配已取消。
Failed

string

群集预配失败。
InProgress

string

群集预配正在进行。
Succeeded

string

群集预配成功。

ClusterSku

群集的 SKU。 这决定了群集的大小/容量。 在 PUT (CreateOrUpdate) 请求上是必需的。

名称 类型 说明
capacity

integer

表示群集可以支持的流单元数。 此属性的有效值为 36 的倍数，最小值为 36，最大值为 216。 在 PUT (CreateOrUpdate) 请求上是必需的。
name

ClusterSkuName

指定群集的 SKU 名称。 在 PUT (CreateOrUpdate) 请求上是必需的。

ClusterSkuName

指定群集的 SKU 名称。 在 PUT (CreateOrUpdate) 请求上是必需的。

名称 类型 说明
Default

string

默认 SKU。

Error

常见错误表示形式。

名称 类型 说明
error

Error

错误定义属性。