Private Link Resources - List By Server

Dienst:

SQL Database

API-Version:

2023-08-01

Ruft die ressourcen für private Verknüpfungen für SQL Server ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateLinkResources?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.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateLinkResourceListResult	Private Linkressourcen wurden erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 InvalidServerName – Ungültiger Servername angegeben. 400 InvalidIdentifier – Der Bezeichner enthält NULL oder ein ungültiges Unicode-Zeichen. 400 TokenTooLong – Das bereitgestellte Token ist zu lang. 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden. 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden. 409 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann. 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde. 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. 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Gets private link resources for SQL.

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateLinkResources?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.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/PrivateLinkResourcesList.json
// this example is just showing the usage of "PrivateLinkResources_ListByServer" 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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "test-svr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlPrivateLinkResource
SqlPrivateLinkResourceCollection collection = sqlServer.GetSqlPrivateLinkResources();

// invoke the operation and iterate over the result
await foreach (SqlPrivateLinkResource 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
    SqlPrivateLinkResourceData 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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateLinkResources/plr",
      "name": "plr",
      "type": "Microsoft.Sql/servers/privateLinkResources",
      "properties": {
        "groupId": "sqlServer",
        "requiredMembers": [
          "sqlServer"
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PrivateLinkResource	Eine private Verknüpfungsressource
PrivateLinkResourceListResult	Eine Liste der privaten Linkressourcen
PrivateLinkResourceProperties	Eigenschaften einer privaten Verknüpfungsressource.

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.

PrivateLinkResource

Objekt

Eine private Verknüpfungsressource

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties	PrivateLinkResourceProperties	Die GRUPPEN-ID der privaten Verknüpfungsressource.
type	string	Ressourcentyp.

PrivateLinkResourceListResult

Objekt

Eine Liste der privaten Linkressourcen

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Seite mit Ergebnissen.
value	PrivateLinkResource[]	Array von Ergebnissen.

PrivateLinkResourceProperties

Objekt

Eigenschaften einer privaten Verknüpfungsressource.

Name	Typ	Beschreibung
groupId	string	Die GRUPPEN-ID der privaten Verknüpfungsressource.
requiredMembers	string[]	Die Namen der privaten Verknüpfungsressource, die Membernamen erforderlich sind.
requiredZoneNames	string[]	Die Namen der privaten Verknüpfungsressource, die für die Zone erforderlich sind.