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

Virtual Clusters - List By Resource Group

服务:: SQL Database

API 版本:: 2023-08-01

获取资源组中虚拟群集的列表。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/virtualClusters?api-version=2023-08-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	VirtualClusterListResult	已成功检索虚拟群集的列表。
Other Status Codes	ErrorResponse	错误响应： *** 400 SubscriptionNotEnabledForFeature - 未为尝试使用的功能用户启用用户订阅。 400 RequestCantLandOnPaaSv2Platform - 请求需要登陆 PaaSv2 平台，但未启用 PaaSv2。 400 CustomMaintenanceWindowIsDisabled - 未启用自定义维护时段。 400 DeleteOfVersion2VirtualClusterIsDisabled - 未启用版本 2 的虚拟群集删除。 400 DeleteOfVirtualClusterIsDisabled - 未启用虚拟群集删除。 400 DnsRefreshOnVirtualClusterIsDisabled - 未启用虚拟群集上的 DNS 记录刷新。 400 ManagementServiceFeatureDisabled - 用户尝试使用禁用的功能。 404 SubscriptionNotFound - 找不到请求的订阅。 404 VirtualClusterDoesNotExist - 虚拟群集不存在。 404 ResourceDoesNotExist - 名称为“{0}”的资源不存在。若要继续，请指定有效的资源名称。 404 VirtualClusterNotInSubscriptionResourceGroup - 指定的虚拟群集在指定的资源组和订阅中不存在。 404 SubscriptionNotFound - 找不到请求的订阅。 404 SubscriptionDoesNotHaveVirtualCluster - 找不到请求的虚拟群集 404 ResourceNotFound - 找不到请求的资源。 409 VirtualClusterRemovalAlreadyInProgress - 正在删除虚拟群集。虚拟群集在创建第一个实例时自动创建，并在上次删除实例时自动删除。在此处了解详细信息：https://aka.ms/sqlmi-virtual-cluster-removal。 409 VirtualClusterIsNotEmpty - 虚拟群集不为空，无法删除。 409 VirtualClusterIsBusy - 虚拟群集当前正忙。请稍后重试作。 409 VirtualClusterRemovalFailed - 请求删除虚拟群集失败。检查是否存在活动依赖资源。 409 ConflictingVirtualClusterOperation - 虚拟群集当前正在进行作。 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。 429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。 429 ConflictingSubscriptionOperation - 订阅当前正在进行作。 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

名称

类型

说明

200 OK

VirtualClusterListResult

已成功检索虚拟群集的列表。

Other Status Codes

ErrorResponse

错误响应： ***

400 SubscriptionNotEnabledForFeature - 未为尝试使用的功能用户启用用户订阅。
400 RequestCantLandOnPaaSv2Platform - 请求需要登陆 PaaSv2 平台，但未启用 PaaSv2。
400 CustomMaintenanceWindowIsDisabled - 未启用自定义维护时段。
400 DeleteOfVersion2VirtualClusterIsDisabled - 未启用版本 2 的虚拟群集删除。
400 DeleteOfVirtualClusterIsDisabled - 未启用虚拟群集删除。
400 DnsRefreshOnVirtualClusterIsDisabled - 未启用虚拟群集上的 DNS 记录刷新。
400 ManagementServiceFeatureDisabled - 用户尝试使用禁用的功能。
404 SubscriptionNotFound - 找不到请求的订阅。
404 VirtualClusterDoesNotExist - 虚拟群集不存在。
404 ResourceDoesNotExist - 名称为“{0}”的资源不存在。若要继续，请指定有效的资源名称。
404 VirtualClusterNotInSubscriptionResourceGroup - 指定的虚拟群集在指定的资源组和订阅中不存在。
404 SubscriptionNotFound - 找不到请求的订阅。
404 SubscriptionDoesNotHaveVirtualCluster - 找不到请求的虚拟群集
404 ResourceNotFound - 找不到请求的资源。
409 VirtualClusterRemovalAlreadyInProgress - 正在删除虚拟群集。虚拟群集在创建第一个实例时自动创建，并在上次删除实例时自动删除。在此处了解详细信息：https://aka.ms/sqlmi-virtual-cluster-removal。
409 VirtualClusterIsNotEmpty - 虚拟群集不为空，无法删除。
409 VirtualClusterIsBusy - 虚拟群集当前正忙。请稍后重试作。
409 VirtualClusterRemovalFailed - 请求删除虚拟群集失败。检查是否存在活动依赖资源。
409 ConflictingVirtualClusterOperation - 虚拟群集当前正在进行作。
429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。
429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。
429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。
429 ConflictingSubscriptionOperation - 订阅当前正在进行作。
503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。
503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

示例

List virtual clusters by resource group

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/VirtualClusterListByResourceGroup.json
// this example is just showing the usage of "VirtualClusters_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "20d7082a-0fc7-4468-82bd-542694d5042b";
string resourceGroupName = "testrg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VirtualClusterResource
VirtualClusterCollection collection = resourceGroupResource.GetVirtualClusters();

// invoke the operation and iterate over the result
await foreach (VirtualClusterResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    VirtualClusterData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "properties": {
        "subnetId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/cltest",
        "version": "1.0",
        "childResources": [
          "/subscriptions/65dc2520-d3b9-4d11-b638-f3c41f962550/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl"
        ]
      },
      "location": "japaneast",
      "id": "/subscriptions/65dc2520-d3b9-4d11-b638-f3c41f962550/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/VirtualClustercltest",
      "name": "VirtualClustercltest",
      "type": "Microsoft.Sql/virtualClusters"
    },
    {
      "properties": {
        "subnetId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/cltest2",
        "version": "2.0",
        "childResources": []
      },
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc2",
      "name": "vc2",
      "type": "Microsoft.Sql/virtualClusters"
    },
    {
      "properties": {
        "subnetId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/cltest",
        "version": "2.0",
        "childResources": [
          "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl",
          "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/mi"
        ]
      },
      "location": "japaneast",
      "tags": {
        "tkey": "tvalue3"
      },
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc1",
      "name": "vc1",
      "type": "Microsoft.Sql/virtualClusters"
    }
  ]
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
VirtualCluster	Azure SQL 虚拟群集。
VirtualClusterListResult	虚拟群集的列表。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

VirtualCluster

Object

Azure SQL 虚拟群集。

名称	类型	说明
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.childResources	string[]	此虚拟群集中的资源列表。
properties.subnetId	string	虚拟群集的子网资源 ID。
properties.version	string	虚拟群集版本。
tags	object	资源标记。
type	string	资源类型。

VirtualClusterListResult

Object

虚拟群集的列表。

名称	类型	说明
nextLink	string	用于检索下一页结果的链接。
value	VirtualCluster[]	结果数组。

通过

Virtual Clusters - List By Resource Group

URI 参数

响应

示例

List virtual clusters by resource group

示例请求

示例响应

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

VirtualCluster

VirtualClusterListResult