Virtual Clusters - List By Resource Group

Service:: SQL Database

API Version:: 2023-08-01

Gets a list of virtual clusters in a resource group.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	VirtualClusterListResult	Successfully retrieved the list of virtual clusters.
Other Status Codes	ErrorResponse	* Error Responses: * 400 SubscriptionNotEnabledForFeature - User subscription not enabled for feature user attempted to use. 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled. 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled. 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled. 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled. 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled. 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled. 404 SubscriptionNotFound - The requested subscription was not found. 404 VirtualClusterDoesNotExist - The virtual cluster does not exist. 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name. 404 VirtualClusterNotInSubscriptionResourceGroup - Specified virtual cluster does not exist in the specified resource group and subscription. 404 SubscriptionNotFound - The requested subscription was not found. 404 SubscriptionDoesNotHaveVirtualCluster - The requested virtual cluster was not found 404 ResourceNotFound - The requested resource was not found. 409 VirtualClusterRemovalAlreadyInProgress - Removal of virtual cluster is already in progress. Virtual cluster is automatically created with first instance creation, and automatically removed with last instance deletion. Learn more here: https://aka.ms/sqlmi-virtual-cluster-removal. 409 VirtualClusterIsNotEmpty - Virtual cluster is not empty and cannot be deleted. 409 VirtualClusterIsBusy - Virtual cluster is currently busy. Please retry operation later. 409 VirtualClusterRemovalFailed - Request to drop virtual cluster failed. Check if there are active dependent resources. 409 ConflictingVirtualClusterOperation - An operation is currently in progress for the virtual cluster. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Name

Type

Description

200 OK

VirtualClusterListResult

Successfully retrieved the list of virtual clusters.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 SubscriptionNotEnabledForFeature - User subscription not enabled for feature user attempted to use.
400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.
400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.
400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.
400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.
400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.
400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.
404 SubscriptionNotFound - The requested subscription was not found.
404 VirtualClusterDoesNotExist - The virtual cluster does not exist.
404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.
404 VirtualClusterNotInSubscriptionResourceGroup - Specified virtual cluster does not exist in the specified resource group and subscription.
404 SubscriptionNotFound - The requested subscription was not found.
404 SubscriptionDoesNotHaveVirtualCluster - The requested virtual cluster was not found
404 ResourceNotFound - The requested resource was not found.
409 VirtualClusterRemovalAlreadyInProgress - Removal of virtual cluster is already in progress. Virtual cluster is automatically created with first instance creation, and automatically removed with last instance deletion. Learn more here: https://aka.ms/sqlmi-virtual-cluster-removal.
409 VirtualClusterIsNotEmpty - Virtual cluster is not empty and cannot be deleted.
409 VirtualClusterIsBusy - Virtual cluster is currently busy. Please retry operation later.
409 VirtualClusterRemovalFailed - Request to drop virtual cluster failed. Check if there are active dependent resources.
409 ConflictingVirtualClusterOperation - An operation is currently in progress for the virtual cluster.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

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

Sample response

Status code:: 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"
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
VirtualCluster	An Azure SQL virtual cluster.
VirtualClusterListResult	A list of virtual clusters.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

VirtualCluster

Object

An Azure SQL virtual cluster.

Name	Type	Description
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.childResources	string[]	List of resources in this virtual cluster.
properties.subnetId	string	Subnet resource ID for the virtual cluster.
properties.version	string	Virtual cluster version.
tags	object	Resource tags.
type	string	Resource type.

VirtualClusterListResult

Object

A list of virtual clusters.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	VirtualCluster[]	Array of results.

Share via

Virtual Clusters - List By Resource Group

URI Parameters

Responses

Examples

List virtual clusters by resource group

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

VirtualCluster

VirtualClusterListResult