Virtual Clusters - List By Resource Group

Servicio:

SQL Database

Versión de la API:

2023-08-01

Obtiene una lista de clústeres virtuales de un grupo de recursos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualClusterListResult	Se recuperó correctamente la lista de clústeres virtuales.
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 SubscriptionNotEnabledForFeature: la suscripción de usuario no está habilitada para la característica que el usuario intentó usar. 400 RequestCantLandOnPaaSv2Platform: la solicitud debe aterrizar en la plataforma PaaSv2, pero PaaSv2 no está habilitada. 400 CustomMaintenanceWindowIsDisabled: la ventana de mantenimiento personalizado no está habilitada. 400 DeleteOfVersion2VirtualClusterIsDisabled: la eliminación del clúster virtual con la versión 2 no está habilitada. 400 DeleteOfVirtualClusterIsDisabled: la eliminación del clúster virtual no está habilitada. 400 DnsRefreshOnVirtualClusterIsDisabled: la actualización de registros DNS en el clúster virtual no está habilitada. 400 ManagementServiceFeatureDisabled: el usuario intentó usar una característica que está deshabilitada. 404 SubscriptionNotFound: no se encontró la suscripción solicitada. 404 VirtualClusterDoesNotExist: el clúster virtual no existe. 404 ResourceDoesNotExist: recurso con el nombre "{0}" no existe. Para continuar, especifique un nombre de recurso válido. 404 VirtualClusterNotInSubscriptionResourceGroup: el clúster virtual especificado no existe en el grupo de recursos y la suscripción especificados. 404 SubscriptionNotFound: no se encontró la suscripción solicitada. 404 SubscriptionDoesNotHaveVirtualCluster: no se encontró el clúster virtual solicitado. 404 ResourceNotFound: no se encontró el recurso solicitado. 409 VirtualClusterRemovalAlreadyInProgress: la eliminación del clúster virtual ya está en curso. El clúster virtual se crea automáticamente con la creación de la primera instancia y se quita automáticamente con la eliminación de última instancia. Más información aquí: https://aka.ms/sqlmi-virtual-cluster-removal. 409 VirtualClusterIsNotEmpty: el clúster virtual no está vacío y no se puede eliminar. 409 VirtualClusterIsBusy: el clúster virtual está ocupado actualmente. Vuelva a intentar la operación más adelante. 409 VirtualClusterRemovalFailed: error en la solicitud para quitar el clúster virtual. Compruebe si hay recursos dependientes activos. 409 ConflictingVirtualClusterOperation: una operación está actualmente en curso para el clúster virtual. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 429 ConflictingSubscriptionOperation: una operación está actualmente en curso para la suscripción. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Ejemplos

List virtual clusters by resource group

Solicitud de ejemplo

HTTP

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

dotnet

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

Respuesta de muestra

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

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
VirtualCluster	Un clúster virtual de Azure SQL.
VirtualClusterListResult	Lista de clústeres virtuales.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

VirtualCluster

Object

Un clúster virtual de Azure SQL.

Nombre	Tipo	Description
id	string	Identificador de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.childResources	string[]	Lista de recursos de este clúster virtual.
properties.subnetId	string	Identificador de recurso de subred para el clúster virtual.
properties.version	string	Versión del clúster virtual.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

VirtualClusterListResult

Object

Lista de clústeres virtuales.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la siguiente página de resultados.
value	VirtualCluster[]	Matriz de resultados.