Servers - Get

Referens

Service:: SQL Database

API Version:: 2021-11-01

Hämtar en server.

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-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
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 ingå i svaret.

Svar

Name	Typ	Description
200 OK	Server	Den angivna servern har hämtats.
Other Status Codes		Felsvar: *** 404 SubscriptionNotFound – Det gick inte att hitta den begärda prenumerationen. 404 ResourceNotFound – Den begärda resursen hittades inte.

Name

Typ

Description

200 OK

Server

Den angivna servern har hämtats.

Other Status Codes

Felsvar: ***

404 SubscriptionNotFound – Det gick inte att hitta den begärda prenumerationen.
404 ResourceNotFound – Den begärda resursen hittades inte.

Exempel

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

Definitioner

Name	Description
AdministratorType	Typ av serveradministratör.
IdentityType	Identitetstypen. Ange "SystemAssigned" (SystemAssigned) för att automatiskt skapa och tilldela ett Azure Active Directory-huvudnamn för resursen.
PrincipalType	Huvudtyp för serveradministratören.
PrivateEndpointConnectionProperties	Egenskaper för en privat slutpunktsanslutning.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Tillstånd 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.
ServerNetworkAccessFlag	Om offentlig slutpunktsåtkomst tillåts för den här servern eller inte. Värdet är valfritt, men om det skickas måste det vara Aktiverat eller Inaktiverat
ServerPrivateEndpointConnection	En privat slutpunktsanslutning under en server
ServerWorkspaceFeature	Om en befintlig server har en arbetsyta skapad eller inte och om den tillåter anslutning från arbetsytan
UserIdentity	Azure Active Directory-identitetskonfiguration för en resurs.

AdministratorType

Typ av serveradministratör.

Name	Typ	Description
ActiveDirectory	string

IdentityType

Identitetstypen. Ange "SystemAssigned" (SystemAssigned) för att automatiskt skapa och tilldela ett Azure Active Directory-huvudnamn för resursen.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Huvudtyp för serveradministratören.

Name	Typ	Description
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

Egenskaper för en privat slutpunktsanslutning.

Name	Typ	Description
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ånd för den privata slutpunktsanslutningen.

PrivateEndpointProperty

Name	Typ	Description
id	string	Resurs-ID för den privata slutpunkten.

PrivateEndpointProvisioningState

Tillstånd för den privata slutpunktsanslutningen.

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

PrivateLinkServiceConnectionStateActionsRequire

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

Name	Typ	Description
None	string

PrivateLinkServiceConnectionStateProperty

Name	Typ	Description
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

Anslutningsstatus för tjänsten Private Link.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

Azure Active Directory-identitetskonfiguration för en resurs.

Name	Typ	Description
principalId	string	Huvud-ID:t för Azure Active Directory.
tenantId	string	Klient-ID:t för Azure Active Directory.
type	IdentityType	Identitetstypen. Ange "SystemAssigned" (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

En Azure SQL Database-server.

Name	Typ	Description
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 Portal upplevelse.
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.
properties.federatedClientId	string	Klient-ID:t som används för cmk-scenario mellan klientorganisationer
properties.fullyQualifiedDomainName	string	Serverns fullständigt kvalificerade domännamn.
properties.keyId	string	En CMK-URI för nyckeln som ska användas för kryptering.
properties.minimalTlsVersion	string	Minimal TLS-version. Tillåtna värden: "1.0", "1.1", "1.2"
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	ServerNetworkAccessFlag	Om offentlig slutpunktsåtkomst tillåts för den här servern eller inte. Värdet är valfritt, men om det skickas måste det vara Aktiverat eller Inaktiverat
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 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 en arbetsyta skapad eller inte och om den tillåter anslutning från arbetsytan
tags	object	Resurstaggar.
type	string	Resurstyp.

ServerExternalAdministrator

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

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

ServerNetworkAccessFlag

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

Name	Typ	Description
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

En privat slutpunktsanslutning under en server

Name	Typ	Description
id	string	Resurs-ID.
properties	PrivateEndpointConnectionProperties	Egenskaper för privat slutpunktsanslutning

ServerWorkspaceFeature

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

Name	Typ	Description
Connected	string
Disconnected	string

UserIdentity

Azure Active Directory-identitetskonfiguration för en resurs.

Name	Typ	Description
clientId	string	Azure Active Directory-klient-ID: t.
principalId	string	Huvud-ID:t för Azure Active Directory.

Servers - Get

URI-parametrar

Svar

Exempel

Get server

Sample Request

Sample Response

Get server with $expand=administrators/activedirectory

Sample Request

Sample Response

Definitioner

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Ytterligare resurser