Servers - Get

Referenz

Service:: SQL Database

API Version:: 2021-11-01

Ruft einen Server ab.

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	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	Server	Der angegebene Server wurde erfolgreich abgerufen.
Other Status Codes		Fehlerantworten: *** 404 SubscriptionNotFound: Das angeforderte Abonnement wurde nicht gefunden. 404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden.

Name

Typ

Beschreibung

200 OK

Server

Der angegebene Server wurde erfolgreich abgerufen.

Other Status Codes

Fehlerantworten: ***

404 SubscriptionNotFound: Das angeforderte Abonnement wurde nicht gefunden.
404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden.

Beispiele

Get server

Get server with $expand=administrators/activedirectory

Get server

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


import com.azure.core.util.Context;

/** Samples for Servers GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerGet.json
     */
    /**
     * Sample code: Get server.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().getByResourceGroupWithResponse("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, 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

Sample Response

Status code:: 200

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

Get server with $expand=administrators/activedirectory

Sample Request

HTTP
Java

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


import com.azure.core.util.Context;

/** Samples for Servers GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ServerGetWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: Get server with $expand=administrators/activedirectory.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getServerWithExpandAdministratorsActivedirectory(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().getByResourceGroupWithResponse("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, 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

Sample Response

Status code:: 200

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

Definitionen

Name	Beschreibung
AdministratorType	Typ des Serveradministrators.
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.
PrincipalType	Prinzipaltyp des Serveradministrators.
PrivateEndpointConnectionProperties	Eigenschaften einer privaten Endpunktverbindung.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Status der Verbindung mit dem privaten Endpunkt.
PrivateLinkServiceConnectionStateActionsRequire	Die für die Private Link-Dienstverbindung erforderlichen Aktionen.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Die Private Link-Dienstverbindung status.
ResourceIdentity	Azure Active Directory-Identitätskonfiguration für eine Ressource.
Server	Ein Azure SQL-Datenbankserver.
ServerExternalAdministrator	Eigenschaften eines Active Directory-Administrators.
ServerNetworkAccessFlag	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 "Aktiviert" oder "Deaktiviert" sein.
ServerPrivateEndpointConnection	Eine private Endpunktverbindung unter einem Server
ServerWorkspaceFeature	Gibt an, ob ein vorhandener Server einen Arbeitsbereich erstellt hat und ob er eine Verbindung vom Arbeitsbereich aus zulässt.
UserIdentity	Azure Active Directory-Identitätskonfiguration für eine Ressource.

AdministratorType

Typ des Serveradministrators.

Name	Typ	Beschreibung
ActiveDirectory	string

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.

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Prinzipaltyp des Serveradministrators.

Name	Typ	Beschreibung
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

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 Verbindung mit dem privaten Endpunkt.
provisioningState	PrivateEndpointProvisioningState	Status der Verbindung mit dem privaten Endpunkt.

PrivateEndpointProperty

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

PrivateEndpointProvisioningState

Status der Verbindung mit dem privaten Endpunkt.

Name	Typ	Beschreibung
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Die für die Private Link-Dienstverbindung erforderlichen Aktionen.

Name	Typ	Beschreibung
None	string

PrivateLinkServiceConnectionStateProperty

Name	Typ	Beschreibung
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Die für die Private Link-Dienstverbindung erforderlichen Aktionen.
description	string	Die Verbindungsbeschreibung des Private Link-Diensts.
status	PrivateLinkServiceConnectionStateStatus	Die Private Link-Dienstverbindung status.

PrivateLinkServiceConnectionStateStatus

Die Private Link-Dienstverbindung status.

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

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

Name	Typ	Beschreibung
principalId	string	Die Azure Active Directory-Prinzipal-ID.
tenantId	string	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

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-Portal-Benutzeroberfläche verwendet werden.
location	string	Ressourcenspeicherort
name	string	Name der Ressource.
properties.administratorLogin	string	Administratorbenutzername für den Server. Nach der Erstellung kann es nicht mehr geändert werden.
properties.administratorLoginPassword	string	Das Administratoranmeldekennwort (erforderlich für die Servererstellung).
properties.administrators	ServerExternalAdministrator	Der Azure Active Directory-Administrator des Servers.
properties.federatedClientId	string	Die Client-ID, die für das mandantenübergreifende CMK-Szenario verwendet wird
properties.fullyQualifiedDomainName	string	Der vollqualifizierte Domänenname des Servers.
properties.keyId	string	Ein CMK-URI des Schlüssels, der für die Verschlüsselung verwendet werden soll.
properties.minimalTlsVersion	string	Minimale TLS-Version. Zulässige Werte: '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	Die Ressourcen-ID einer benutzerseitig zugewiesenen Identität, die standardmäßig verwendet werden soll.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Liste der Privaten Endpunktverbindungen auf einem Server
properties.publicNetworkAccess	ServerNetworkAccessFlag	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 "Aktiviert" oder "Deaktiviert" 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 "Aktiviert" oder "Deaktiviert" sein.
properties.state	string	Der Status des Servers.
properties.version	string	Die Serverversion.
properties.workspaceFeature	ServerWorkspaceFeature	Gibt an, ob ein vorhandener Server einen Arbeitsbereich erstellt hat und ob er eine Verbindung vom Arbeitsbereich aus zulässt.
tags	object	Ressourcentags.
type	string	Der Ressourcentyp.

ServerExternalAdministrator

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	SID (Objekt-ID) des Serveradministrators.
tenantId	string	Mandanten-ID des Administrators.

ServerNetworkAccessFlag

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 "Aktiviert" oder "Deaktiviert" sein.

Name	Typ	Beschreibung
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

Eine private Endpunktverbindung unter einem Server

Name	Typ	Beschreibung
id	string	Ressourcen-ID
properties	PrivateEndpointConnectionProperties	Verbindungseigenschaften für private Endpunkte

ServerWorkspaceFeature

Gibt an, ob ein vorhandener Server einen Arbeitsbereich erstellt hat und ob er eine Verbindung vom Arbeitsbereich aus zulässt.

Name	Typ	Beschreibung
Connected	string
Disconnected	string

UserIdentity

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

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

Servers - Get

URI-Parameter

Antworten

Beispiele

Get server

Sample Request

Sample Response

Get server with $expand=administrators/activedirectory

Sample Request

Sample Response

Definitionen

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Zusätzliche Ressourcen