Servers - List

Tjänst:: SQL Database

API-versionen:: 2023-08-01

Hämtar en lista över alla servrar i prenumerationen.

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

Med valfria parametrar:

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.
$expand	query		string	De underordnade resurser som ska inkluderas i svaret.

Svaren

Namn	Typ	Beskrivning
200 OK	ServerListResult	Listan över servrar har hämtats.
Other Status Codes	ErrorResponse	Felsvar: *** 404 SubscriptionNotFound – Det gick inte att hitta den begärda prenumerationen. 429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser. 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Namn

Typ

Beskrivning

200 OK

ServerListResult

Listan över servrar har hämtats.

Other Status Codes

ErrorResponse

Felsvar: ***

404 SubscriptionNotFound – Det gick inte att hitta den begärda prenumerationen.
429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser.
503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

List servers

List servers with $expand=administrators/activedirectory

List servers

Exempelförfrågan

HTTP

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

Exempelsvar

Statuskod:: 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

Exempelförfrågan

HTTP

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

Exempelsvar

Statuskod:: 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"
              }
            }
          }
        ]
      }
    }
  ]
}

Definitioner

Namn	Beskrivning
AdministratorType	Typ av administratör för serverservern.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ExternalGovernanceStatus	Status för extern styrning.
IdentityType	Identitetstypen. Ställ in detta på "SystemAssigned" för att automatiskt skapa och tilldela ett Azure Active Directory-huvudnamn för resursen.
MinimalTlsVersion	Minimal TLS-version. Tillåtna värden: "None", 1.0", "1.1", "1.2", "1.3"
PrincipalType	Huvudtyp för sever-administratören.
PrivateEndpointConnectionProperties	Egenskaper för en privat slutpunktsanslutning.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Tillståndet för den privata slutpunktsanslutningen.
PrivateLinkServiceConnectionStateActionsRequire	De åtgärder som krävs för privat länktjänstanslutning.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Anslutningsstatus för tjänsten private link.
ResourceIdentity	Azure Active Directory-identitetskonfiguration för en resurs.
Server	En Azure SQL Database-server.
ServerExternalAdministrator	Egenskaper för en Active Directory-administratör.
ServerListResult	En lista över servrar.
ServerNetworkAccessFlag	Om du vill begränsa utgående nätverksåtkomst för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat"
ServerPrivateEndpointConnection	En privat slutpunktsanslutning under en server
ServerPublicNetworkAccessFlag	Om offentlig slutpunktsåtkomst tillåts för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat" eller "SecuredByPerimeter"
ServerWorkspaceFeature	Om en befintlig server har skapat en arbetsyta eller inte och om den tillåter anslutning från arbetsytan
UserIdentity	Azure Active Directory-identitetskonfiguration för en resurs.

AdministratorType

Uppräkning

Typ av administratör för serverservern.

Värde	Beskrivning
ActiveDirectory

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Namn	Typ	Beskrivning
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Namn	Typ	Beskrivning
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Namn	Typ	Beskrivning
error	ErrorDetail	Felobjektet.

ExternalGovernanceStatus

Uppräkning

Status för extern styrning.

Värde	Beskrivning
Enabled
Disabled

IdentityType

Uppräkning

Identitetstypen. Ställ in detta på "SystemAssigned" för att automatiskt skapa och tilldela ett Azure Active Directory-huvudnamn för resursen.

Värde	Beskrivning
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MinimalTlsVersion

Uppräkning

Minimal TLS-version. Tillåtna värden: "None", 1.0", "1.1", "1.2", "1.3"

Värde	Beskrivning
None
1.0
1.1
1.2
1.3

PrincipalType

Uppräkning

Huvudtyp för sever-administratören.

Värde	Beskrivning
User
Group
Application

PrivateEndpointConnectionProperties

Objekt

Egenskaper för en privat slutpunktsanslutning.

Namn	Typ	Beskrivning
groupIds	string[]	Grupp-ID:t.
privateEndpoint	PrivateEndpointProperty	Privat slutpunkt som anslutningen tillhör.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Anslutningstillstånd för den privata slutpunktsanslutningen.
provisioningState	PrivateEndpointProvisioningState	Tillståndet för den privata slutpunktsanslutningen.

PrivateEndpointProperty

Objekt

Namn	Typ	Beskrivning
id	string	Resurs-ID för den privata slutpunkten.

PrivateEndpointProvisioningState

Uppräkning

Tillståndet för den privata slutpunktsanslutningen.

Värde	Beskrivning
Approving
Ready
Dropping
Failed
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Uppräkning

De åtgärder som krävs för privat länktjänstanslutning.

Värde	Beskrivning
None

PrivateLinkServiceConnectionStateProperty

Objekt

Namn	Typ	Beskrivning
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	De åtgärder som krävs för privat länktjänstanslutning.
description	string	Beskrivning av tjänstanslutningen för privat länk.
status	PrivateLinkServiceConnectionStateStatus	Anslutningsstatus för tjänsten private link.

PrivateLinkServiceConnectionStateStatus

Uppräkning

Anslutningsstatus för tjänsten private link.

Värde	Beskrivning
Approved
Pending
Rejected
Disconnected

ResourceIdentity

Objekt

Azure Active Directory-identitetskonfiguration för en resurs.

Namn	Typ	Beskrivning
principalId	string (uuid)	Huvud-ID:t för Azure Active Directory.
tenantId	string (uuid)	Klient-ID:t för Azure Active Directory.
type	IdentityType	Identitetstypen. Ställ in detta på "SystemAssigned" för att automatiskt skapa och tilldela ett Azure Active Directory-huvudnamn för resursen.
userAssignedIdentities	<string, UserIdentity>	Resurs-ID:n för de användartilldelade identiteter som ska användas

Server

Objekt

En Azure SQL Database-server.

Namn	Typ	Beskrivning
id	string	Resurs-ID.
identity	ResourceIdentity	Azure Active Directory-identiteten för servern.
kind	string	Typ av SQL-server. Det här är metadata som används för Azure-portalen.
location	string	Resursplats.
name	string	Resursnamn.
properties.administratorLogin	string	Administratörsanvändarnamn för servern. När den har skapats kan den inte ändras.
properties.administratorLoginPassword	string	Administratörens inloggningslösenord (krävs för att skapa servern).
properties.administrators	ServerExternalAdministrator	Azure Active Directory-administratören för servern. Detta kan endast användas vid serverskapningstid. Om det används för serveruppdatering ignoreras det eller så resulterar det i ett fel. För uppdateringar måste enskilda API:er användas.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Status för extern styrning.
properties.federatedClientId	string (uuid)	Klient-ID:t som används för cmk-scenario mellan klientorganisationer
properties.fullyQualifiedDomainName	string	Serverns fullständigt kvalificerade domännamn.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Om du vill aktivera IPv6-stöd för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat"
properties.keyId	string	En CMK-URI för nyckeln som ska användas för kryptering.
properties.minimalTlsVersion	MinimalTlsVersion	Minimal TLS-version. Tillåtna värden: "None", 1.0", "1.1", "1.2", "1.3"
properties.primaryUserAssignedIdentityId	string	Resurs-ID för en användartilldelad identitet som ska användas som standard.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista över privata slutpunktsanslutningar på en server
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Om offentlig slutpunktsåtkomst tillåts för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat" eller "SecuredByPerimeter"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Om du vill begränsa utgående nätverksåtkomst för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat"
properties.state	string	Serverns tillstånd.
properties.version	string	Serverns version.
properties.workspaceFeature	ServerWorkspaceFeature	Om en befintlig server har skapat en arbetsyta eller inte och om den tillåter anslutning från arbetsytan
tags	object	Resurstaggar.
type	string	Resurstyp.

ServerExternalAdministrator

Objekt

Egenskaper för en Active Directory-administratör.

Namn	Typ	Beskrivning
administratorType	AdministratorType	Typ av administratör för serverservern.
azureADOnlyAuthentication	boolean	Endast Azure Active Directory-autentisering aktiverat.
login	string	Serveradministratörens inloggningsnamn.
principalType	PrincipalType	Huvudtyp för sever-administratören.
sid	string (uuid)	SID (objekt-ID) för serveradministratören.
tenantId	string (uuid)	Administratörens klientorganisations-ID.

ServerListResult

Objekt

En lista över servrar.

Namn	Typ	Beskrivning
nextLink	string	Länka för att hämta nästa sida med resultat.
value	Server[]	Matris med resultat.

ServerNetworkAccessFlag

Uppräkning

Om du vill begränsa utgående nätverksåtkomst för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat"

Värde	Beskrivning
Enabled
Disabled

ServerPrivateEndpointConnection

Objekt

En privat slutpunktsanslutning under en server

Namn	Typ	Beskrivning
id	string	Resurs-ID.
properties	PrivateEndpointConnectionProperties	Egenskaper för privat slutpunktsanslutning

ServerPublicNetworkAccessFlag

Uppräkning

Om offentlig slutpunktsåtkomst tillåts för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat" eller "SecuredByPerimeter"

Värde	Beskrivning
Enabled
Disabled
SecuredByPerimeter

ServerWorkspaceFeature

Uppräkning

Om en befintlig server har skapat en arbetsyta eller inte och om den tillåter anslutning från arbetsytan

Värde	Beskrivning
Connected
Disconnected

UserIdentity

Objekt

Azure Active Directory-identitetskonfiguration för en resurs.

Namn	Typ	Beskrivning
clientId	string (uuid)	Azure Active Directory-klient-ID: t.
principalId	string (uuid)	Huvud-ID:t för Azure Active Directory.

Dela via

Servers - List

URI-parametrar

Svaren

Exempel

List servers

Exempelförfrågan

Exempelsvar

List servers with $expand=administrators/activedirectory

Exempelförfrågan

Exempelsvar

Definitioner

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

UserIdentity