Servers - Get

Odwołanie

Usługa:: SQL Database

Wersja interfejsu API:: 2021-11-01

Pobiera serwer.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.
$expand	query		string	Zasoby podrzędne do uwzględnienia w odpowiedzi.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Server	Pomyślnie pobrano określony serwer.
Other Status Codes		Odpowiedzi na błędy: *** 404 SubscriptionNotFound — nie znaleziono żądanej subskrypcji. 404 ResourceNotFound — żądany zasób nie został znaleziony.

Nazwa

Typ

Opis

200 OK

Server

Pomyślnie pobrano określony serwer.

Other Status Codes

Odpowiedzi na błędy: ***

404 SubscriptionNotFound — nie znaleziono żądanej subskrypcji.
404 ResourceNotFound — żądany zasób nie został znaleziony.

Przykłady

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


/**
 * 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, com.azure.core.util.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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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


/**
 * 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, com.azure.core.util.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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
AdministratorType	Typ administratora serwera.
IdentityType	Typ tożsamości. Ustaw tę wartość na wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.
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 połączenia usługi private link.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Stan połączenia usługi private link.
ResourceIdentity	Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.
Server	Serwer bazy danych Azure SQL.
ServerExternalAdministrator	Właściwości administratora usługi Active Directory.
ServerNetworkAccessFlag	Niezależnie od tego, 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"
ServerPrivateEndpointConnection	Połączenie prywatnego punktu końcowego na serwerze
ServerWorkspaceFeature	Czy istniejący serwer ma utworzony obszar roboczy i czy zezwala na połączenie z obszaru roboczego
UserIdentity	Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

AdministratorType

Typ administratora serwera.

Nazwa	Typ	Opis
ActiveDirectory	string

IdentityType

Typ tożsamości. Ustaw tę wartość na wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Typ podmiotu zabezpieczeń administratora serwera.

Nazwa	Typ	Opis
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

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

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

PrivateEndpointProvisioningState

Stan połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Akcje wymagane do połączenia usługi private link.

Nazwa	Typ	Opis
None	string

PrivateLinkServiceConnectionStateProperty

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

PrivateLinkServiceConnectionStateStatus

Stan połączenia usługi private link.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory.
tenantId	string	Identyfikator dzierżawy usługi Azure Active Directory.
type	IdentityType	Typ tożsamości. Ustaw tę wartość na wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.
userAssignedIdentities	<string, UserIdentity>	Identyfikatory zasobów tożsamości przypisanych przez użytkownika do użycia

Server

Serwer bazy danych Azure SQL.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
identity	ResourceIdentity	Tożsamość usługi Azure Active Directory serwera.
kind	string	Rodzaj serwera SQL. Są to metadane używane w środowisku Azure Portal.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.administratorLogin	string	Nazwa użytkownika administratora serwera. Po utworzeniu nie można go zmienić.
properties.administratorLoginPassword	string	Hasło logowania administratora (wymagane do utworzenia serwera).
properties.administrators	ServerExternalAdministrator	Administrator usługi Azure Active Directory serwera.
properties.federatedClientId	string	Identyfikator klienta używany w scenariuszu cmK między dzierżawami
properties.fullyQualifiedDomainName	string	W pełni kwalifikowana nazwa domeny serwera.
properties.keyId	string	Identyfikator URI klucza do użycia na potrzeby szyfrowania.
properties.minimalTlsVersion	string	Minimalna wersja protokołu TLS. Dozwolone wartości: "1.0", "1.1", "1.2"
properties.primaryUserAssignedIdentityId	string	Identyfikator zasobu tożsamości przypisanej przez użytkownika domyślnie używany.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista połączeń prywatnego punktu końcowego na serwerze
properties.publicNetworkAccess	ServerNetworkAccessFlag	Niezależnie od tego, 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"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Niezależnie od tego, czy należy 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.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
tags	object	Tagi zasobów.
type	string	Typ zasobu.

ServerExternalAdministrator

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

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

ServerNetworkAccessFlag

Niezależnie od tego, 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"

Nazwa	Typ	Opis
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

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

ServerWorkspaceFeature

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

Nazwa	Typ	Opis
Connected	string
Disconnected	string

UserIdentity

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta usługi Azure Active Directory.
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory.

Udostępnij za pośrednictwem

Servers - Get

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Get server

Przykładowe żądanie

Przykładowa odpowiedź

Get server with $expand=administrators/activedirectory

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Dodatkowe zasoby