Virtual Clusters - List By Resource Group

Szolgáltatás:

SQL Database

API-verzió:

2023-08-01

Lekéri az erőforráscsoportban lévő virtuális fürtök listáját.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
subscriptionId	path	True	string	Az Azure-előfizetést azonosító előfizetés-azonosító.
api-version	query	True	string	A kéréshez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	VirtualClusterListResult	Sikeresen lekérte a virtuális fürtök listáját.
Other Status Codes	ErrorResponse	Hibaválaszok: *** 400 SubscriptionNotEnabledForFeature – A felhasználó előfizetése nincs engedélyezve a szolgáltatásfelhasználó által megkísérelt használathoz. 400 RequestCantLandOnPaaSv2Platform – A kérésnek a PaaSv2 platformra kell leszállnia, de a PaaSv2 nincs engedélyezve. 400 CustomMaintenanceWindowIsDisabled – Az egyéni karbantartási időszak nincs engedélyezve. 400 DeleteOfVersion2VirtualClusterIsDisabled – A 2-es verziójú virtuális fürt törlése nincs engedélyezve. 400 DeleteOfVirtualClusterIsDisabled – A virtuális fürt törlése nincs engedélyezve. 400 DnsRefreshOnVirtualClusterIsDisabled – A virtuális fürt DNS-rekordjainak frissítése nincs engedélyezve. 400 ManagementServiceFeatureDisabled – A felhasználó letiltott funkciót próbált használni. 404 SubscriptionNotFound – A kért előfizetés nem található. 404 VirtualClusterDoesNotExist – A virtuális fürt nem létezik. 404 ResourceDoesNotExist – Az "{0}" nevű erőforrás nem létezik. A folytatáshoz adjon meg egy érvényes erőforrásnevet. 404 VirtualClusterNotInSubscriptionResourceGroup – A megadott virtuális fürt nem létezik a megadott erőforráscsoportban és -előfizetésben. 404 SubscriptionNotFound – A kért előfizetés nem található. 404 SubscriptionDoesNotHaveVirtualCluster – A kért virtuális fürt nem található 404 ResourceNotFound – A kért erőforrás nem található. 409 VirtualClusterRemovalAlreadyInProgress – A virtuális fürt eltávolítása már folyamatban van. A virtuális fürt automatikusan létrejön az első példány létrehozásával, és automatikusan törlődik az utolsó példány törlésével. További információ: https://aka.ms/sqlmi-virtual-cluster-removal. 409 VirtualClusterIsNotEmpty – A virtuális fürt nem üres, és nem törölhető. 409 VirtualClusterIsBusy – A virtuális fürt jelenleg foglalt. Később próbálkozzon újra a művelettel. 409 VirtualClusterRemovalFailed – A virtuális fürt elvetésére irányuló kérelem sikertelen volt. Ellenőrizze, hogy vannak-e aktív függő erőforrások. 409 ConflictingVirtualClusterOperation – Folyamatban van egy művelet a virtuális fürthöz. 429 SubscriptionTooManyRequests – Az elérhető erőforrások által feldolgozható kérelmek maximálisnál több kérése. 429 SubscriptionTooManyCreateUpdateRequests – Az elérhető erőforrások által feldolgozható maximális kéréseken túli kérések. 429 SubscriptionTooManyRequests – Az elérhető erőforrások által feldolgozható kérelmek maximálisnál több kérése. 429 ConflictingSubscriptionOperation – Folyamatban van egy művelet az előfizetéshez. 503 TooManyRequests – A rendelkezésre álló erőforrások által feldolgozható maximális kérelmeken túli kérések. 503 TooManyRequests – A rendelkezésre álló erőforrások által feldolgozható maximális kérelmeken túli kérések.

Példák

List virtual clusters by resource group

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
VirtualCluster	Egy Azure SQL virtuális fürt.
VirtualClusterListResult	Virtuális fürtök listája.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

VirtualCluster

Objektum

Egy Azure SQL virtuális fürt.

Name	Típus	Description
id	string	Erőforrás-azonosító.
location	string	Erőforrás helye.
name	string	Erőforrás neve.
properties.childResources	string[]	A virtuális fürt erőforrásainak listája.
properties.subnetId	string	A virtuális fürt alhálózati erőforrás-azonosítója.
properties.version	string	Virtuális fürt verziója.
tags	object	Erőforráscímkék.
type	string	Erőforrás típusa.

VirtualClusterListResult

Objektum

Virtuális fürtök listája.

Name	Típus	Description
nextLink	string	Hivatkozás az eredmények következő oldalának lekéréséhez.
value	VirtualCluster[]	Eredménytömb.