Servers - List By Resource Group

Dienst:

SQL Database

API-Version:

2023-08-01

Ruft eine Liste der Server in einer Ressourcengruppe ab.

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

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers?$expand={$expand}&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.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.
$expand	query		string	Die untergeordneten Ressourcen, die in die Antwort eingeschlossen werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	ServerListResult	Die Liste der Server wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 404 SubscriptionNotFound – Das angeforderte Abonnement wurde nicht gefunden. 429 SubscriptionTooManyRequests – 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

List servers by resource group

List servers by resource group with $expand=administrators/activedirectory

List servers by resource group

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers?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.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerListByResourceGroup.json
// this example is just showing the usage of "Servers_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 = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SqlServerResource
SqlServerCollection collection = resourceGroupResource.GetSqlServers();

// invoke the operation and iterate over the result
await foreach (SqlServerResource 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
    SqlServerData 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/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
      "name": "sqlcrudtest-4645",
      "type": "Microsoft.Sql/servers",
      "location": "japaneast",
      "kind": "v12.0",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
        "administratorLogin": "dummylogin",
        "version": "12.0",
        "state": "Ready",
        "workspaceFeature": "Connected",
        "publicNetworkAccess": "Enabled",
        "restrictOutboundNetworkAccess": "Enabled",
        "isIPv6Enabled": "Enabled",
        "externalGovernanceStatus": "Enabled",
        "privateEndpointConnections": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
            "properties": {
              "provisioningState": "Ready",
              "privateEndpoint": {
                "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "description": "Auto-approved",
                "actionsRequired": "None"
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
      "name": "sqlcrudtest-6661",
      "type": "Microsoft.Sql/servers",
      "location": "japaneast",
      "kind": "v12.0",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-6661.database.windows.net",
        "administratorLogin": "dummylogin",
        "version": "12.0",
        "state": "Ready",
        "workspaceFeature": "Connected",
        "publicNetworkAccess": "Enabled",
        "restrictOutboundNetworkAccess": "Enabled",
        "isIPv6Enabled": "Enabled",
        "externalGovernanceStatus": "Enabled",
        "privateEndpointConnections": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
            "properties": {
              "provisioningState": "Ready",
              "privateEndpoint": {
                "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "description": "Auto-approved",
                "actionsRequired": "None"
              }
            }
          }
        ]
      }
    }
  ]
}

List servers by resource group with $expand=administrators/activedirectory

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers?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.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerListByResourceGroupWithExpandEqualsAdministrators.json
// this example is just showing the usage of "Servers_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 = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SqlServerResource
SqlServerCollection collection = resourceGroupResource.GetSqlServers();

// invoke the operation and iterate over the result
await foreach (SqlServerResource 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
    SqlServerData 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/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
      "name": "sqlcrudtest-4645",
      "type": "Microsoft.Sql/servers",
      "location": "japaneast",
      "kind": "v12.0",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
        "administratorLogin": "dummylogin",
        "version": "12.0",
        "state": "Ready",
        "workspaceFeature": "Connected",
        "publicNetworkAccess": "Enabled",
        "restrictOutboundNetworkAccess": "Enabled",
        "isIPv6Enabled": "Enabled",
        "externalGovernanceStatus": "Enabled",
        "administrators": {
          "principalType": "User",
          "login": "bob@contoso.com",
          "sid": "00000011-1111-2222-2222-123456789111",
          "tenantId": "00000011-1111-2222-2222-123456789111",
          "azureADOnlyAuthentication": true
        },
        "privateEndpointConnections": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
            "properties": {
              "provisioningState": "Ready",
              "privateEndpoint": {
                "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "description": "Auto-approved",
                "actionsRequired": "None"
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
      "name": "sqlcrudtest-6661",
      "type": "Microsoft.Sql/servers",
      "location": "japaneast",
      "kind": "v12.0",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-6661.database.windows.net",
        "administratorLogin": "dummylogin",
        "version": "12.0",
        "state": "Ready",
        "workspaceFeature": "Connected",
        "publicNetworkAccess": "Enabled",
        "restrictOutboundNetworkAccess": "Enabled",
        "isIPv6Enabled": "Enabled",
        "externalGovernanceStatus": "Enabled",
        "administrators": {
          "principalType": "User",
          "login": "bob@contoso.com",
          "sid": "00000011-1111-2222-2222-123456789111",
          "tenantId": "00000011-1111-2222-2222-123456789111",
          "azureADOnlyAuthentication": true
        },
        "privateEndpointConnections": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
            "properties": {
              "provisioningState": "Ready",
              "privateEndpoint": {
                "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "description": "Auto-approved",
                "actionsRequired": "None"
              }
            }
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AdministratorType	Typ des Serveradministrators.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ExternalGovernanceStatus	Status der externen Governance.
IdentityType	Der Identitätstyp. Legen Sie dies auf "SystemAssigned" fest, um automatisch einen Azure Active Directory-Prinzipal für die Ressource zu erstellen und zuzuweisen.
MinimalTlsVersion	Minimale TLS-Version. Zulässige Werte: 'None', 1.0', '1.1', '1.2', '1.3'
PrincipalType	Prinzipaltyp des Serveradministrators.
PrivateEndpointConnectionProperties	Eigenschaften einer privaten Endpunktverbindung.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionStateActionsRequire	Die aktionen, die für die Verbindung mit privatem Linkdienst erforderlich sind.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Der Verbindungsstatus des privaten Verknüpfungsdiensts.
ResourceIdentity	Azure Active Directory-Identitätskonfiguration für eine Ressource.
Server	Ein Azure SQL-Datenbankserver.
ServerExternalAdministrator	Eigenschaften eines Active Directory-Administrators.
ServerListResult	Eine Liste der Server.
ServerNetworkAccessFlag	Gibt an, ob der ausgehende Netzwerkzugriff für diesen Server eingeschränkt werden soll. Der Wert ist optional, aber wenn er übergeben wird, muss 'Enabled' oder 'Disabled' sein.
ServerPrivateEndpointConnection	Eine private Endpunktverbindung unter einem Server
ServerPublicNetworkAccessFlag	Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen Server zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Enabled' oder 'Disabled' oder 'SecuredByPerimeter' sein.
ServerWorkspaceFeature	Gibt an, ob ein vorhandener Server einen Arbeitsbereich erstellt hat und ob die Verbindung vom Arbeitsbereich aus zulässig ist.
UserIdentity	Azure Active Directory-Identitätskonfiguration für eine Ressource.

AdministratorType

Enumeration

Typ des Serveradministrators.

Wert	Beschreibung
ActiveDirectory

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.

ExternalGovernanceStatus

Enumeration

Status der externen Governance.

Wert	Beschreibung
Disabled
Enabled

IdentityType

Enumeration

Der Identitätstyp. Legen Sie dies auf "SystemAssigned" fest, um automatisch einen Azure Active Directory-Prinzipal für die Ressource zu erstellen und zuzuweisen.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Enumeration

Minimale TLS-Version. Zulässige Werte: 'None', 1.0', '1.1', '1.2', '1.3'

Wert	Beschreibung
1.0
1.1
1.2
1.3
None

PrincipalType

Enumeration

Prinzipaltyp des Serveradministrators.

Wert	Beschreibung
Application
Group
User

PrivateEndpointConnectionProperties

Objekt

Eigenschaften einer privaten Endpunktverbindung.

Name	Typ	Beschreibung
groupIds	string[]	Gruppen-IDs.
privateEndpoint	PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der privaten Endpunktverbindung.
provisioningState	PrivateEndpointProvisioningState	Status der privaten Endpunktverbindung.

PrivateEndpointProperty

Objekt

Name	Typ	Beschreibung
id	string	Ressourcen-ID des privaten Endpunkts.

PrivateEndpointProvisioningState

Enumeration

Status der privaten Endpunktverbindung.

Wert	Beschreibung
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeration

Die aktionen, die für die Verbindung mit privatem Linkdienst erforderlich sind.

Wert	Beschreibung
None

PrivateLinkServiceConnectionStateProperty

Objekt

Name	Typ	Beschreibung
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Die aktionen, die für die Verbindung mit privatem Linkdienst erforderlich sind.
description	string	Die Verbindungsbeschreibung des privaten Linksdiensts.
status	PrivateLinkServiceConnectionStateStatus	Der Verbindungsstatus des privaten Verknüpfungsdiensts.

PrivateLinkServiceConnectionStateStatus

Enumeration

Der Verbindungsstatus des privaten Verknüpfungsdiensts.

Wert	Beschreibung
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Objekt

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Name	Typ	Beschreibung
principalId	string (uuid)	Die Azure Active Directory-Prinzipal-ID.
tenantId	string (uuid)	Die Azure Active Directory-Mandanten-ID.
type	IdentityType	Der Identitätstyp. Legen Sie dies auf "SystemAssigned" fest, um automatisch einen Azure Active Directory-Prinzipal für die Ressource zu erstellen und zuzuweisen.
userAssignedIdentities	<string,  UserIdentity>	Die Ressourcen-IDs der vom Benutzer zugewiesenen Identitäten, die verwendet werden sollen

Server

Objekt

Ein Azure SQL-Datenbankserver.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
identity	ResourceIdentity	Die Azure Active Directory-Identität des Servers.
kind	string	Art von SQL Server. Dies sind Metadaten, die für die Azure-Portaloberfläche verwendet werden.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.administratorLogin	string	Administratorbenutzername für den Server. Nach der Erstellung kann sie nicht mehr geändert werden.
properties.administratorLoginPassword	string	Das Administratoranmeldungskennwort (erforderlich für die Servererstellung).
properties.administrators	ServerExternalAdministrator	Der Azure Active Directory-Administrator des Servers. Dies kann nur zum Zeitpunkt der Servererstellung verwendet werden. Wenn sie für die Serveraktualisierung verwendet wird, wird sie ignoriert, oder sie führt zu einem Fehler. Für Updates müssen einzelne APIs verwendet werden.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Status der externen Governance.
properties.federatedClientId	string (uuid)	Die Client-ID, die für das mandantenübergreifende CMK-Szenario verwendet wird
properties.fullyQualifiedDomainName	string	Der vollqualifizierte Domänenname des Servers.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Gibt an, ob die IPv6-Unterstützung für diesen Server aktiviert werden soll. Der Wert ist optional, aber wenn er übergeben wird, muss 'Enabled' oder 'Disabled' sein.
properties.keyId	string	Ein CMK-URI des Schlüssels, der für die Verschlüsselung verwendet werden soll.
properties.minimalTlsVersion	MinimalTlsVersion	Minimale TLS-Version. Zulässige Werte: 'None', 1.0', '1.1', '1.2', '1.3'
properties.primaryUserAssignedIdentityId	string	Die Ressourcen-ID einer vom Benutzer zugewiesenen Identität, die standardmäßig verwendet werden soll.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Liste der privaten Endpunktverbindungen auf einem Server
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen Server zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Enabled' oder 'Disabled' oder 'SecuredByPerimeter' sein.
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Gibt an, ob der ausgehende Netzwerkzugriff für diesen Server eingeschränkt werden soll. Der Wert ist optional, aber wenn er übergeben wird, muss 'Enabled' oder 'Disabled' sein.
properties.state	string	Der Status des Servers.
properties.version	string	Die Version des Servers.
properties.workspaceFeature	ServerWorkspaceFeature	Gibt an, ob ein vorhandener Server einen Arbeitsbereich erstellt hat und ob die Verbindung vom Arbeitsbereich aus zulässig ist.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

ServerExternalAdministrator

Objekt

Eigenschaften eines Active Directory-Administrators.

Name	Typ	Beschreibung
administratorType	AdministratorType	Typ des Serveradministrators.
azureADOnlyAuthentication	boolean	Nur Azure Active Directory-Authentifizierung aktiviert.
login	string	Anmeldename des Serveradministrators.
principalType	PrincipalType	Prinzipaltyp des Serveradministrators.
sid	string (uuid)	SID (Objekt-ID) des Serveradministrators.
tenantId	string (uuid)	Mandanten-ID des Administrators.

ServerListResult

Objekt

Eine Liste der Server.

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

ServerNetworkAccessFlag

Enumeration

Gibt an, ob der ausgehende Netzwerkzugriff für diesen Server eingeschränkt werden soll. Der Wert ist optional, aber wenn er übergeben wird, muss 'Enabled' oder 'Disabled' sein.

Wert	Beschreibung
Disabled
Enabled

ServerPrivateEndpointConnection

Objekt

Eine private Endpunktverbindung unter einem Server

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
properties	PrivateEndpointConnectionProperties	Eigenschaften der privaten Endpunktverbindung

ServerPublicNetworkAccessFlag

Enumeration

Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen Server zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Enabled' oder 'Disabled' oder 'SecuredByPerimeter' sein.

Wert	Beschreibung
Disabled
Enabled
SecuredByPerimeter

ServerWorkspaceFeature

Enumeration

Gibt an, ob ein vorhandener Server einen Arbeitsbereich erstellt hat und ob die Verbindung vom Arbeitsbereich aus zulässig ist.

Wert	Beschreibung
Connected
Disconnected

UserIdentity

Objekt

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Name	Typ	Beschreibung
clientId	string (uuid)	Die Azure Active Directory-Client-ID.
principalId	string (uuid)	Die Azure Active Directory-Prinzipal-ID.