Virtual Clusters - Get

Dienst:

SQL Database

API-Version:

2023-08-01

Ruft einen virtuellen Cluster ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
virtualClusterName	path	True	string	Der Name des virtuellen Clusters.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualCluster	Der angegebene virtuelle Cluster wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 SubscriptionNotEnabledForFeature – Benutzerabonnement für Featurebenutzer wurde nicht aktiviert. 400 RequestCantLandOnPaaSv2Platform - Anforderung muss auf der PaaSv2-Plattform landen, aber PaaSv2 ist nicht aktiviert. 400 CustomMaintenanceWindowIsDisabled – Benutzerdefiniertes Wartungsfenster ist nicht aktiviert. 400 DeleteOfVersion2VirtualClusterIsDisabled – Das Löschen des virtuellen Clusters mit Version 2 ist nicht aktiviert. 400 DeleteOfVirtualClusterIsDisabled – Das Löschen des virtuellen Clusters ist nicht aktiviert. 400 DnsRefreshOnVirtualClusterIsDisabled – Aktualisierung von DNS-Einträgen auf virtuellem Cluster ist nicht aktiviert. 400 ManagementServiceFeatureDisabled – Der Benutzer hat versucht, ein Feature zu verwenden, das deaktiviert ist. 404 SubscriptionNotFound – Das angeforderte Abonnement wurde nicht gefunden. 404 VirtualClusterDoesNotExist – Der virtuelle Cluster ist nicht vorhanden. 404 ResourceDoesNotExist - Ressource mit dem Namen '{0}' ist nicht vorhanden. Geben Sie einen gültigen Ressourcennamen an, um den Vorgang fortzusetzen. 404 VirtualClusterNotInSubscriptionResourceGroup – Der angegebene virtuelle Cluster ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 SubscriptionNotFound – Das angeforderte Abonnement wurde nicht gefunden. 404 SubscriptionDoesNotHaveVirtualCluster – Der angeforderte virtuelle Cluster wurde nicht gefunden. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden. 409 VirtualClusterRemovalAlreadyInProgress – Das Entfernen des virtuellen Clusters ist bereits in Bearbeitung. Der virtuelle Cluster wird automatisch mit der Erstellung der ersten Instanz erstellt und automatisch mit der letzten Instanz gelöscht. Weitere Informationen finden Sie hier: https://aka.ms/sqlmi-virtual-cluster-removal. 409 VirtualClusterIsNotEmpty – Virtueller Cluster ist nicht leer und kann nicht gelöscht werden. 409 VirtualClusterIsBusy – Virtueller Cluster ist derzeit ausgelastet. Versuchen Sie es später erneut. 409 VirtualClusterRemovalFailed – Anforderung zum Ablegen des virtuellen Clusters fehlgeschlagen. Überprüfen Sie, ob aktive abhängige Ressourcen vorhanden sind. 409 ConflictingVirtualClusterOperation – Ein Vorgang wird derzeit für den virtuellen Cluster ausgeführt. 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 429 ConflictingSubscriptionOperation – Ein Vorgang wird derzeit für das Abonnement ausgeführt. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Gets a virtual cluster

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-f769ed71-b3ad-491a-a9d5-26eeceaa6be2?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/VirtualClusterGet.json
// this example is just showing the usage of "VirtualClusters_Get" 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
string virtualClusterName = "vc-f769ed71-b3ad-491a-a9d5-26eeceaa6be2";
NullableResponse<VirtualClusterResource> response = await collection.GetIfExistsAsync(virtualClusterName);
VirtualClusterResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

200

{
  "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": {
    "key": "value"
  },
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
  "name": "vc-f769ed71-b3ad-491a-a9d5-26eeceaa6be2",
  "type": "Microsoft.Sql/virtualClusters"
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
VirtualCluster	Ein virtueller Azure SQL-Cluster.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

VirtualCluster

Objekt

Ein virtueller Azure SQL-Cluster.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.childResources	string[]	Liste der Ressourcen in diesem virtuellen Cluster.
properties.subnetId	string	Subnetzressourcen-ID für den virtuellen Cluster.
properties.version	string	Virtuelle Clusterversion.
tags	object	Ressourcentags.
type	string	Ressourcentyp.