Servers - List

Usługa:: SQL Database

Wersja interfejsu API:: 2025-01-01

Pobiera listę wszystkich serwerów w subskrypcji.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$expand	query		string	Zasoby podrzędne do uwzględnienia w odpowiedzi.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ServerListResult	Operacja Azure zakończyła się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List servers

List servers with $expand=administrators/activedirectory

List servers

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

List servers with $expand=administrators/activedirectory

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
AdministratorType	Typ administratora serwera.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ExternalGovernanceStatus	Stan nadzoru zewnętrznego.
IdentityType	Typ tożsamości. Ustaw to na 'SystemAssigned', aby automatycznie utworzyć i przypisać zasadę Azure Active Directory dla zasobu.
MinimalTlsVersion	Minimalna wersja protokołu TLS. Dozwolone wartości: "None", 1.0", "1.1", "1.2", "1.3"
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 nawiązania połączenia z usługą private link.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Stan połączenia usługi private link.
ResourceIdentity	Azure Active Directory identity configuration for a resource.
Server	An Azure SQL Database server.
ServerCreateMode	Utwórz tryb dla serwera, jedynymi prawidłowymi wartościami dla tego są Normalny i Przywróć.
ServerExternalAdministrator	Właściwości administratora usługi Active Directory.
ServerListResult	Odpowiedź operacji listy serwerów.
ServerNetworkAccessFlag	Określa, czy 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"
ServerPrivateEndpointConnection	Połączenie prywatnego punktu końcowego na serwerze
ServerPublicNetworkAccessFlag	Określa, 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" lub "SecuredByPerimeter"
ServerWorkspaceFeature	Czy istniejący serwer ma utworzony obszar roboczy i czy zezwala na połączenie z obszaru roboczego
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserIdentity	Azure Active Directory identity configuration for a resource.

AdministratorType

Wyliczenie

Typ administratora serwera.

Wartość	Opis
ActiveDirectory	Usługa ActiveDirectory

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Błąd dodatkowe informacje.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ExternalGovernanceStatus

Wyliczenie

Stan nadzoru zewnętrznego.

Wartość	Opis
Enabled	Enabled
Disabled	Wyłączony

IdentityType

Wyliczenie

Typ tożsamości. Ustaw to na 'SystemAssigned', aby automatycznie utworzyć i przypisać zasadę Azure Active Directory dla zasobu.

Wartość	Opis
None	Żadne
SystemAssigned	SystemowoPrzydzielony
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SystemPrzypisany,Przypisany przez użytkownika

MinimalTlsVersion

Wyliczenie

Minimalna wersja protokołu TLS. Dozwolone wartości: "None", 1.0", "1.1", "1.2", "1.3"

Wartość	Opis
None	Żadne
1.0	1.0
1.1	1.1
1.2	1.2
1.3	1.3

PrincipalType

Wyliczenie

Typ podmiotu zabezpieczeń administratora serwera.

Wartość	Opis
User	Użytkownik
Group	Grupa
Application	Application

PrivateEndpointConnectionProperties

Objekt

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

Objekt

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

PrivateEndpointProvisioningState

Wyliczenie

Stan połączenia prywatnego punktu końcowego.

Wartość	Opis
Approving	Zatwierdzanie
Ready	Ready
Dropping	Upuszczanie
Failed	Niepowodzenie
Rejecting	Odrzucenie

PrivateLinkServiceConnectionStateActionsRequire

Wyliczenie

Akcje wymagane do nawiązania połączenia z usługą private link.

Wartość	Opis
None	Żadne

PrivateLinkServiceConnectionStateProperty

Objekt

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

PrivateLinkServiceConnectionStateStatus

Wyliczenie

Stan połączenia usługi private link.

Wartość	Opis
Approved	Zatwierdzony
Pending	W oczekiwaniu
Rejected	Odrzucone
Disconnected	Disconnected

ResourceIdentity

Objekt

Azure Active Directory identity configuration for a resource.

Nazwa	Typ	Opis
principalId	string (uuid)	The Azure Active Directory principal id.
tenantId	string (uuid)	Identyfikator tenant Azure Active Directory.
type	IdentityType	Typ tożsamości. Ustaw to na 'SystemAssigned', aby automatycznie utworzyć i przypisać zasadę Azure Active Directory dla zasobu.
userAssignedIdentities	<string, UserIdentity>	Identyfikatory zasobów tożsamości przypisanych przez użytkownika do użycia

Server

Objekt

An Azure SQL Database server.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ResourceIdentity	Tożsamość serwera w Azure Active Directory.
kind	string	Rodzaj programu SQL Server. To metadane używane w doświadczeniu portalu Azure.
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.administratorLogin	string	Nazwa użytkownika administratora serwera. Po utworzeniu nie można go zmienić.
properties.administratorLoginPassword	string (password)	Hasło logowania administratora (wymagane do utworzenia serwera).
properties.administrators	ServerExternalAdministrator	Administrator Azure Active Directory może być używany podczas tworzenia serwera oraz aktualizacji serwera, z wyjątkiem właściwości azureADOnlyAuthentication. Aby zaktualizować właściwość azureADOnlyAuthentication, należy użyć indywidualnego interfejsu API.
properties.createMode	ServerCreateMode	Utwórz tryb dla serwera, jedynymi prawidłowymi wartościami dla tego są Normalny i Przywróć.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Stan nadzoru zewnętrznego.
properties.federatedClientId	string (uuid)	Identyfikator klienta używany w scenariuszu cmK między dzierżawami
properties.fullyQualifiedDomainName	string	W pełni kwalifikowana nazwa domeny serwera.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Czy włączyć obsługę protokołu IPv6 dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
properties.keyId	string	Identyfikator URI klucza cmK do użycia na potrzeby szyfrowania.
properties.minimalTlsVersion	MinimalTlsVersion	Minimalna wersja protokołu TLS. Dozwolone wartości: "None", 1.0", "1.1", "1.2", "1.3"
properties.primaryUserAssignedIdentityId	string	Identyfikator zasobu tożsamości przypisanej przez użytkownika domyślnie używany.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista połączeń prywatnych punktów końcowych na serwerze
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Określa, 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" lub "SecuredByPerimeter"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Określa, czy 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.retentionDays	integer (int32)	Liczba dni, przez które ten serwer pozostanie usunięty nietrwale.
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
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

ServerCreateMode

Wyliczenie

Utwórz tryb dla serwera, jedynymi prawidłowymi wartościami dla tego są Normalny i Przywróć.

Wartość	Opis
Normal	Standardowy
Restore	Restore

ServerExternalAdministrator

Objekt

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

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

ServerListResult

Objekt

Odpowiedź operacji listy serwerów.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	Server[]	Elementy serwera na tej stronie

ServerNetworkAccessFlag

Wyliczenie

Określa, czy 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"

Wartość	Opis
Enabled	Enabled
Disabled	Wyłączony

ServerPrivateEndpointConnection

Objekt

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

ServerPublicNetworkAccessFlag

Wyliczenie

Określa, 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" lub "SecuredByPerimeter"

Wartość	Opis
Enabled	Enabled
Disabled	Wyłączony
SecuredByPerimeter	SecuredByPerimeter

ServerWorkspaceFeature

Wyliczenie

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

Wartość	Opis
Connected	Połączono
Disconnected	Disconnected

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserIdentity

Objekt

Azure Active Directory identity configuration for a resource.

Nazwa	Typ	Opis
clientId	string (uuid)	Identyfikator klienta Azure Active Directory.
principalId	string (uuid)	The Azure Active Directory principal id.

Udostępnij za pośrednictwem

Servers - List

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

List servers

Przykładowe żądanie

Przykładowa odpowiedź

List servers with $expand=administrators/activedirectory

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AdministratorType

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerCreateMode

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

systemData

UserIdentity