Virtual Clusters - Get

Gets a virtual cluster.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/virtualClusters/{virtualClusterName}?api-version=2021-11-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.

virtualClusterName
path True

string

The name of the virtual cluster.

api-version
query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

VirtualCluster

Successfully retrieved the specified virtual cluster.

Other Status Codes

*** Error Responses: ***

  • 400 SubscriptionNotEnabledForFeature - User subscription not enabled for feature user attempted to use.

  • 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 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.

Examples

Get virtual cluster

Sample request

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-subnet1-f769ed71-b3ad-491a-a9d5-26eeceaa6be2?api-version=2021-11-01

Sample response

{
  "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"
}

Definitions

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.