Servers - Get

Riferimento

Servizio:: SQL Database

Versione API:: 2021-11-01

Ottiene un server.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
serverName	path	True	string	Nome del server.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare per la richiesta.
$expand	query		string	Risorse figlio da includere nella risposta.

Risposte

Nome	Tipo	Descrizione
200 OK	Server	È stato recuperato correttamente il server specificato.
Other Status Codes		Risposte di errore: 404 SubscriptionNotFound: la sottoscrizione richiesta non è stata trovata. 404 ResourceNotFound: la risorsa richiesta non è stata trovata.

Nome

Tipo

Descrizione

200 OK

Server

È stato recuperato correttamente il server specificato.

Other Status Codes

Risposte di errore:

404 SubscriptionNotFound: la sottoscrizione richiesta non è stata trovata.
404 ResourceNotFound: la risorsa richiesta non è stata trovata.

Esempio

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

Risposta di esempio

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
          }
        }
      }
    ]
  }
}

Definizioni

Nome	Descrizione
AdministratorType	Tipo di amministratore del server.
IdentityType	Tipo di identità. Impostare questa opzione su "SystemAssigned" per creare e assegnare automaticamente un'entità di Azure Active Directory per la risorsa.
PrincipalType	Tipo di entità dell'amministratore del server.
PrivateEndpointConnectionProperties	Proprietà di una connessione endpoint privato.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Stato della connessione dell'endpoint privato.
PrivateLinkServiceConnectionStateActionsRequire	Azioni necessarie per la connessione al servizio di collegamento privato.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Stato della connessione al servizio di collegamento privato.
ResourceIdentity	Configurazione dell'identità di Azure Active Directory per una risorsa.
Server	Un server di database Azure SQL.
ServerExternalAdministrator	Proprietà di un amministratore di Active Directory.
ServerNetworkAccessFlag	Indica se l'accesso all'endpoint pubblico è consentito per questo server. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'
ServerPrivateEndpointConnection	Una connessione endpoint privato in un server
ServerWorkspaceFeature	Indica se nel server esistente è stata creata un'area di lavoro e se consente la connessione dall'area di lavoro
UserIdentity	Configurazione dell'identità di Azure Active Directory per una risorsa.

AdministratorType

Enumeration

Tipo di amministratore del server.

Valore	Descrizione
ActiveDirectory

IdentityType

Enumeration

Tipo di identità. Impostare questa opzione su "SystemAssigned" per creare e assegnare automaticamente un'entità di Azure Active Directory per la risorsa.

Valore	Descrizione
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

PrincipalType

Enumeration

Tipo di entità dell'amministratore del server.

Valore	Descrizione
Application
Group
User

PrivateEndpointConnectionProperties

Object

Proprietà di una connessione endpoint privato.

Nome	Tipo	Descrizione
groupIds	string[]	ID gruppo.
privateEndpoint	PrivateEndpointProperty	Endpoint privato a cui appartiene la connessione.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Stato di connessione della connessione dell'endpoint privato.
provisioningState	PrivateEndpointProvisioningState	Stato della connessione dell'endpoint privato.

PrivateEndpointProperty

Object

Nome	Tipo	Descrizione
id	string	ID risorsa dell'endpoint privato.

PrivateEndpointProvisioningState

Enumeration

Stato della connessione dell'endpoint privato.

Valore	Descrizione
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeration

Azioni necessarie per la connessione al servizio di collegamento privato.

Valore	Descrizione
None

PrivateLinkServiceConnectionStateProperty

Object

Nome	Tipo	Descrizione
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Azioni necessarie per la connessione al servizio di collegamento privato.
description	string	Descrizione della connessione al servizio di collegamento privato.
status	PrivateLinkServiceConnectionStateStatus	Stato della connessione al servizio di collegamento privato.

PrivateLinkServiceConnectionStateStatus

Enumeration

Stato della connessione al servizio di collegamento privato.

Valore	Descrizione
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Object

Configurazione dell'identità di Azure Active Directory per una risorsa.

Nome	Tipo	Descrizione
principalId	string	ID entità di Azure Active Directory.
tenantId	string	ID tenant di Azure Active Directory.
type	IdentityType	Tipo di identità. Impostare questa opzione su "SystemAssigned" per creare e assegnare automaticamente un'entità di Azure Active Directory per la risorsa.
userAssignedIdentities	<string, UserIdentity>	ID risorsa delle identità assegnate dall'utente da usare

Server

Object

Un server di database Azure SQL.

Nome	Tipo	Descrizione
id	string	ID risorsa.
identity	ResourceIdentity	Identità di Azure Active Directory del server.
kind	string	Tipo di sql server. Si tratta di metadati usati per l'esperienza di portale di Azure.
location	string	Percorso della risorsa.
name	string	Nome risorsa.
properties.administratorLogin	string	Nome utente amministratore per il server. Una volta creata, non è possibile modificarla.
properties.administratorLoginPassword	string	Password di accesso dell'amministratore (necessaria per la creazione del server).
properties.administrators	ServerExternalAdministrator	Amministratore di Azure Active Directory del server.
properties.federatedClientId	string	ID client usato per lo scenario cmk tra tenant
properties.fullyQualifiedDomainName	string	Nome di dominio completo del server.
properties.keyId	string	URI cmk della chiave da usare per la crittografia.
properties.minimalTlsVersion	string	Versione minima di TLS. Valori consentiti: '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	ID risorsa di un'identità assegnata dall'utente da usare per impostazione predefinita.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Elenco di connessioni di endpoint privato in un server
properties.publicNetworkAccess	ServerNetworkAccessFlag	Indica se l'accesso all'endpoint pubblico è consentito per questo server. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Indica se limitare o meno l'accesso alla rete in uscita per questo server. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'
properties.state	string	Stato del server.
properties.version	string	Versione del server.
properties.workspaceFeature	ServerWorkspaceFeature	Indica se nel server esistente è stata creata un'area di lavoro e se consente la connessione dall'area di lavoro
tags	object	Tag delle risorse.
type	string	Tipo di risorsa.

ServerExternalAdministrator

Object

Proprietà di un amministratore di Active Directory.

Nome	Tipo	Descrizione
administratorType	AdministratorType	Tipo di amministratore del server.
azureADOnlyAuthentication	boolean	Autenticazione di Azure Active Directory abilitata solo.
login	string	Nome di accesso dell'amministratore del server.
principalType	PrincipalType	Tipo di entità dell'amministratore del server.
sid	string	SID (ID oggetto) dell'amministratore del server.
tenantId	string	ID tenant dell'amministratore.

ServerNetworkAccessFlag

Enumeration

Indica se l'accesso all'endpoint pubblico è consentito per questo server. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'

Valore	Descrizione
Disabled
Enabled

ServerPrivateEndpointConnection

Object

Una connessione endpoint privato in un server

Nome	Tipo	Descrizione
id	string	ID risorsa.
properties	PrivateEndpointConnectionProperties	Proprietà di connessione dell'endpoint privato

ServerWorkspaceFeature

Enumeration

Indica se nel server esistente è stata creata un'area di lavoro e se consente la connessione dall'area di lavoro

Valore	Descrizione
Connected
Disconnected

UserIdentity

Object

Configurazione dell'identità di Azure Active Directory per una risorsa.

Nome	Tipo	Descrizione
clientId	string	ID client di Azure Active Directory.
principalId	string	ID entità di Azure Active Directory.

Condividi tramite

Servers - Get

Parametri dell'URI

Risposte

Esempio

Get server

Esempio di richiesta

Risposta di esempio

Get server with $expand=administrators/activedirectory

Esempio di richiesta

Risposta di esempio

Definizioni

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Risorse aggiuntive