Servers - Get

Dienst:: SQL Database

API-Version:: 2025-01-01

Erhält einen Server.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$expand	query		string	Die untergeordneten Ressourcen, die in die Antwort eingeschlossen werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	Server	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get server

Get server with $expand=administrators/activedirectory

Get server

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "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",
    "retentionDays": 7,
    "state": "Ready",
    "version": "12.0",
    "workspaceFeature": "Connected"
  },
  "tags": {
    "tagKey1": "TagValue1"
  }
}

Get server with $expand=administrators/activedirectory

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "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"
  },
  "tags": {
    "tagKey1": "TagValue1"
  }
}

Definitionen

Name	Beschreibung
AdministratorType	Typ des Serveradministrators.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ExternalGovernanceStatus	Status der externen Governance.
IdentityType	Der Identitätstyp. Setzen Sie dies auf 'SystemAssigned', um automatisch einen Azure Active Directory-Principal 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	An Azure SQL-Datenbank server.
ServerCreateMode	Erstellungsmodus für Server, nur gültige Werte dafür sind Normal und Wiederherstellen.
ServerExternalAdministrator	Eigenschaften eines Active Directory-Administrators.
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.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserIdentity	Azure Active Directory Identitätskonfiguration für eine Ressource.

AdministratorType

Enumeration

Typ des Serveradministrators.

Wert	Beschreibung
ActiveDirectory	Aktives Verzeichnis

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

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
Enabled	Aktiviert
Disabled	Deaktiviert

IdentityType

Enumeration

Der Identitätstyp. Setzen Sie dies auf 'SystemAssigned', um automatisch einen Azure Active Directory-Principal für die Ressource zu erstellen und zuzuweisen.

Wert	Beschreibung
None	Nichts
SystemAssigned	SystemAssigned
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SystemZugewiesen, BenutzerZugewiesen

MinimalTlsVersion

Enumeration

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

Wert	Beschreibung
None	Nichts
1.0	1.0
1.1	1.1
1.2	1.2
1.3	1.3

PrincipalType

Enumeration

Prinzipaltyp des Serveradministrators.

Wert	Beschreibung
User	Benutzer
Group	Gruppieren
Application	Application

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	Genehmigung
Ready	Bereit
Dropping	Abwurf
Failed	gescheitert
Rejecting	Ablehnung

PrivateLinkServiceConnectionStateActionsRequire

Enumeration

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

Wert	Beschreibung
None	Nichts

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	Genehmigt
Pending	Ausstehend
Rejected	Abgelehnt
Disconnected	Verbindung unterbrochen

ResourceIdentity

Objekt

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

Name	Typ	Beschreibung
principalId	string (uuid)	Die Azure Active Directory principal id.
tenantId	string (uuid)	Das Azure Active Directory tenant id.
type	IdentityType	Der Identitätstyp. Setzen Sie dies auf 'SystemAssigned', um automatisch einen Azure Active Directory-Principal 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

An Azure SQL-Datenbank server.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ResourceIdentity	Die Azure Active Directory-Identität des Servers.
kind	string	Art von SQL Server. Dies sind Metadaten, die für das Azure-Portal-Erlebnis verwendet werden.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.administratorLogin	string	Administratorbenutzername für den Server. Nach der Erstellung kann sie nicht mehr geändert werden.
properties.administratorLoginPassword	string (password)	Das Administratoranmeldungskennwort (erforderlich für die Servererstellung).
properties.administrators	ServerExternalAdministrator	Der Azure Active Directory-Administrator kann während der Servererstellung und für Serverupdates verwendet werden, mit Ausnahme der azureADOnlyAuthentication-Eigenschaft. Zum Aktualisieren der azureADOnlyAuthentication-Eigenschaft muss eine einzelne API verwendet werden.
properties.createMode	ServerCreateMode	Erstellungsmodus für Server, nur gültige Werte dafür sind Normal und Wiederherstellen.
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.retentionDays	integer (int32)	Anzahl der Tage, für die dieser Server vorläufig gelöscht wird.
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.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

ServerCreateMode

Enumeration

Erstellungsmodus für Server, nur gültige Werte dafür sind Normal und Wiederherstellen.

Wert	Beschreibung
Normal	Normal
Restore	Wiederherstellen

ServerExternalAdministrator

Objekt

Eigenschaften eines Active Directory-Administrators.

Name	Typ	Beschreibung
administratorType	AdministratorType	Typ des Serveradministrators.
azureADOnlyAuthentication	boolean	Azure Active Directory nur 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.

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
Enabled	Aktiviert
Disabled	Deaktiviert

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
Enabled	Aktiviert
Disabled	Deaktiviert
SecuredByPerimeter	Vom Perimeter gesichert

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	Verbunden
Disconnected	Verbindung unterbrochen

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserIdentity

Objekt

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

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

Freigeben über

Servers - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get server

Beispielanforderung

Beispiel für eine Antwort

Get server with $expand=administrators/activedirectory

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AdministratorType

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerCreateMode

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

systemData

UserIdentity