Virtual Clusters - List

Service:

SQL Database

API Version:

2021-11-01

Gets a list of all virtualClusters in the subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/virtualClusters?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
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		*** Error Responses: *** 404 SubscriptionNotFound - The requested subscription was not found.

Examples

List virtualClusters

Sample request

HTTP

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

Java

/**
 * Samples for VirtualClusters List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/VirtualClusterList.json
     */
    /**
     * Sample code: List virtualClusters.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listVirtualClusters(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getVirtualClusters().list(com.azure.core.util.Context.NONE);
    }
}

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/vnet1/subnets/subnet1",
        "family": "Gen4",
        "childResources": [
          "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance1",
          "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance2"
        ],
        "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/resourceGroups/Federation/providers/Microsoft.Maintenance/maintenanceConfigurations/MiPolicy1"
      },
      "location": "onebox",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
      "name": "vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
      "type": "Microsoft.Sql/virtualClusters"
    },
    {
      "properties": {
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2",
        "family": "Gen5",
        "childResources": [
          "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance3",
          "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance4"
        ],
        "maintenanceConfigurationId": "/subscriptions/ab0e51c0-83c0-4380-8ae9-025516df392f/resourceGroups/Federation/providers/Microsoft.Maintenance/maintenanceConfigurations/MiPolicy1"
      },
      "location": "onebox",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-subnet2-14b795bd-9c8f-46ec-adb8-2b8eff56ac16",
      "name": "vc-subnet1-14b795bd-9c8f-46ec-adb8-2b8eff56ac16",
      "type": "Microsoft.Sql/virtualClusters"
    }
  ]
}

Definitions

Name	Description
VirtualCluster	An Azure SQL virtual cluster.
VirtualClusterListResult	A list of virtual clusters.

VirtualCluster

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.family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
properties.maintenanceConfigurationId	string	Specifies maintenance configuration id to apply to this virtual cluster.
properties.subnetId	string	Subnet resource ID for the virtual cluster.
tags	object	Resource tags.
type	string	Resource type.

VirtualClusterListResult

A list of virtual clusters.

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