Servers - List

Odwołanie

Usługa:: SQL Database

Wersja interfejsu API:: 2021-11-01

Pobiera listę wszystkich serwerów w subskrypcji.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers?api-version=2021-11-01

Z parametrami opcjonalnymi:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers?$expand={$expand}&api-version=2021-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.
$expand	query		string	Zasoby podrzędne do uwzględnienia w odpowiedzi.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ServerListResult	Pomyślnie pobrano listę serwerów.
Other Status Codes		Odpowiedzi na błędy: *** 404 SubscriptionNotFound — nie znaleziono żądanej subskrypcji.

Nazwa

Typ

Opis

200 OK

ServerListResult

Pomyślnie pobrano listę serwerów.

Other Status Codes

Odpowiedzi na błędy: ***

404 SubscriptionNotFound — nie znaleziono żądanej subskrypcji.

Przykłady

List servers

List servers with $expand=administrators/activedirectory

List servers

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers?api-version=2021-11-01


/**
 * Samples for Servers List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerList.json
     */
    /**
     * Sample code: List servers.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listServers(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().list(null, com.azure.core.util.Context.NONE);
    }
}

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

Przykładowa odpowiedź

Kod stanu:: 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",
        "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",
        "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 with $expand=administrators/activedirectory

Przykładowe żądanie

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers?api-version=2021-11-01


/**
 * Samples for Servers List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ServerListWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: List servers with $expand=administrators/activedirectory.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listServersWithExpandAdministratorsActivedirectory(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().list(null, com.azure.core.util.Context.NONE);
    }
}

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

Przykładowa odpowiedź

Kod stanu:: 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",
        "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",
        "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"
              }
            }
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
AdministratorType	Typ administratora serwera.
IdentityType	Typ tożsamości. Ustaw tę wartość na wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.
PrincipalType	Typ podmiotu zabezpieczeń administratora serwera.
PrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionStateActionsRequire	Akcje wymagane do połączenia usługi private link.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Stan połączenia usługi private link.
ResourceIdentity	Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.
Server	Serwer bazy danych Azure SQL.
ServerExternalAdministrator	Właściwości administratora usługi Active Directory.
ServerListResult	Lista serwerów.
ServerNetworkAccessFlag	Niezależnie od tego, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
ServerPrivateEndpointConnection	Połączenie prywatnego punktu końcowego na serwerze
ServerWorkspaceFeature	Czy istniejący serwer ma utworzony obszar roboczy i czy zezwala na połączenie z obszaru roboczego
UserIdentity	Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

AdministratorType

Enumeration

Typ administratora serwera.

Wartość	Opis
ActiveDirectory

IdentityType

Enumeration

Typ tożsamości. Ustaw tę wartość na wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.

Wartość	Opis
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

PrincipalType

Enumeration

Typ podmiotu zabezpieczeń administratora serwera.

Wartość	Opis
Application
Group
User

PrivateEndpointConnectionProperties

Object

Właściwości połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
groupIds	string[]	Identyfikatory grup.
privateEndpoint	PrivateEndpointProperty	Prywatny punkt końcowy, do którego należy połączenie.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Stan połączenia prywatnego punktu końcowego.
provisioningState	PrivateEndpointProvisioningState	Stan połączenia prywatnego punktu końcowego.

PrivateEndpointProperty

Object

Nazwa	Typ	Opis
id	string	Identyfikator zasobu prywatnego punktu końcowego.

PrivateEndpointProvisioningState

Enumeration

Stan połączenia prywatnego punktu końcowego.

Wartość	Opis
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeration

Akcje wymagane do połączenia usługi private link.

Wartość	Opis
None

PrivateLinkServiceConnectionStateProperty

Object

Nazwa	Typ	Opis
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Akcje wymagane do połączenia usługi private link.
description	string	Opis połączenia usługi private link.
status	PrivateLinkServiceConnectionStateStatus	Stan połączenia usługi private link.

PrivateLinkServiceConnectionStateStatus

Enumeration

Stan połączenia usługi private link.

Wartość	Opis
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Object

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory.
tenantId	string	Identyfikator dzierżawy usługi Azure Active Directory.
type	IdentityType	Typ tożsamości. Ustaw tę wartość na wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.
userAssignedIdentities	<string, UserIdentity>	Identyfikatory zasobów tożsamości przypisanych przez użytkownika do użycia

Server

Object

Serwer bazy danych Azure SQL.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
identity	ResourceIdentity	Tożsamość usługi Azure Active Directory serwera.
kind	string	Rodzaj serwera SQL. Są to metadane używane w środowisku Azure Portal.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.administratorLogin	string	Nazwa użytkownika administratora serwera. Po utworzeniu nie można go zmienić.
properties.administratorLoginPassword	string	Hasło logowania administratora (wymagane do utworzenia serwera).
properties.administrators	ServerExternalAdministrator	Administrator usługi Azure Active Directory serwera.
properties.federatedClientId	string	Identyfikator klienta używany w scenariuszu cmK między dzierżawami
properties.fullyQualifiedDomainName	string	W pełni kwalifikowana nazwa domeny serwera.
properties.keyId	string	Identyfikator URI klucza do użycia na potrzeby szyfrowania.
properties.minimalTlsVersion	string	Minimalna wersja protokołu TLS. Dozwolone wartości: "1.0", "1.1", "1.2"
properties.primaryUserAssignedIdentityId	string	Identyfikator zasobu tożsamości przypisanej przez użytkownika domyślnie używany.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista połączeń prywatnego punktu końcowego na serwerze
properties.publicNetworkAccess	ServerNetworkAccessFlag	Niezależnie od tego, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Niezależnie od tego, czy należy ograniczyć dostęp do sieci wychodzącej dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
properties.state	string	Stan serwera.
properties.version	string	Wersja serwera.
properties.workspaceFeature	ServerWorkspaceFeature	Czy istniejący serwer ma utworzony obszar roboczy i czy zezwala na połączenie z obszaru roboczego
tags	object	Tagi zasobów.
type	string	Typ zasobu.

ServerExternalAdministrator

Object

Właściwości administratora usługi Active Directory.

Nazwa	Typ	Opis
administratorType	AdministratorType	Typ administratora serwera.
azureADOnlyAuthentication	boolean	Włączono tylko uwierzytelnianie usługi Azure Active Directory.
login	string	Nazwa logowania administratora serwera.
principalType	PrincipalType	Typ podmiotu zabezpieczeń administratora serwera.
sid	string	Identyfikator SID (identyfikator obiektu) administratora serwera.
tenantId	string	Identyfikator dzierżawy administratora.

ServerListResult

Object

Lista serwerów.

Nazwa	Typ	Opis
nextLink	string	Link, aby pobrać następną stronę wyników.
value	Server[]	Tablica wyników.

ServerNetworkAccessFlag

Enumeration

Niezależnie od tego, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"

Wartość	Opis
Disabled
Enabled

ServerPrivateEndpointConnection

Object

Połączenie prywatnego punktu końcowego na serwerze

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
properties	PrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego

ServerWorkspaceFeature

Enumeration

Czy istniejący serwer ma utworzony obszar roboczy i czy zezwala na połączenie z obszaru roboczego

Wartość	Opis
Connected
Disconnected

UserIdentity

Object

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta usługi Azure Active Directory.
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory.

Udostępnij za pośrednictwem

Servers - List

Parametry identyfikatora URI

Odpowiedzi

Przykłady

List servers

Przykładowe żądanie

Przykładowa odpowiedź

List servers with $expand=administrators/activedirectory

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Dodatkowe zasoby