Condividi tramite

Servers - Get

Servizio:
SQL Database
Versione API:
2025-01-01

Ottiene un server.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
serverName
 path True

string

Il nome del server.
subscriptionId
 path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.
$expand
 query

string

Risorse figlio da includere nella risposta.

Risposte

Nome Tipo Descrizione
200 OK

Server

Operazione Azure completata con successo.
Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Get server
Get server with $expand=administrators/activedirectory

Get server

Esempio di richiesta

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

Risposta di esempio

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

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
AdministratorType

Tipo dell'amministratore di sever.
createdByType

Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
ExternalGovernanceStatus

Stato della governance esterna.
IdentityType

Tipo di identità. Imposta questo su 'SystemAssigned' per creare e assegnare automaticamente un Azure Active Directory principal per la risorsa.
MinimalTlsVersion

Versione minima di TLS. Valori consentiti: 'Nessuno', 1.0', '1.1', '1.2', '1.3'
PrincipalType

Tipo di entità dell'amministratore di sever.
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 collegamento privato.
ResourceIdentity

Azure Active Directory configurazione dell'identità per una risorsa.
Server

Un server database SQL di Azure.
ServerCreateMode

Modalità di creazione per il server, gli unici valori validi per questo sono Normale e Ripristino.
ServerExternalAdministrator

Proprietà di un amministratore di Active Directory.
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'
ServerPrivateEndpointConnection

Una connessione endpoint privato in un server
ServerPublicNetworkAccessFlag

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

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

Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserIdentity

Azure Active Directory configurazione dell'identità per una risorsa.

AdministratorType

Enumerazione

Tipo dell'amministratore di sever.

Valore Descrizione
ActiveDirectory

Istanza di ActiveDirectory

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

ExternalGovernanceStatus

Enumerazione

Stato della governance esterna.

Valore Descrizione
Enabled

Enabled
Disabled

Disattivato

IdentityType

Enumerazione

Tipo di identità. Imposta questo su 'SystemAssigned' per creare e assegnare automaticamente un Azure Active Directory principal per la risorsa.

Valore Descrizione
None

Nessuno
SystemAssigned

Assegnato dal sistema
UserAssigned

UserAssigned
SystemAssigned,UserAssigned

SystemAssigned, UserAssigned

MinimalTlsVersion

Enumerazione

Versione minima di TLS. Valori consentiti: 'Nessuno', 1.0', '1.1', '1.2', '1.3'

Valore Descrizione
None

Nessuno
1.0

1.0
1.1

1.1
1.2

1.2
1.3

1.3

PrincipalType

Enumerazione

Tipo di entità dell'amministratore di sever.

Valore Descrizione
User

User
Group

Gruppo
Application

Applicazione

PrivateEndpointConnectionProperties

Oggetto

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 della connessione dell'endpoint privato.
provisioningState

PrivateEndpointProvisioningState

Stato della connessione dell'endpoint privato.

PrivateEndpointProperty

Oggetto
Nome Tipo Descrizione
id

string

ID risorsa dell'endpoint privato.

PrivateEndpointProvisioningState

Enumerazione

Stato della connessione dell'endpoint privato.

Valore Descrizione
Approving

Approvazione
Ready

Ready
Dropping

Cadere
Failed

Non riuscito
Rejecting

Rifiuto

PrivateLinkServiceConnectionStateActionsRequire

Enumerazione

Azioni necessarie per la connessione al servizio di collegamento privato.

Valore Descrizione
None

Nessuno

PrivateLinkServiceConnectionStateProperty

Oggetto
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 collegamento privato.

PrivateLinkServiceConnectionStateStatus

Enumerazione

Stato della connessione al servizio collegamento privato.

Valore Descrizione
Approved

Approvato
Pending

In sospeso
Rejected

Rifiutato
Disconnected

Scollegato

ResourceIdentity

Oggetto

Azure Active Directory configurazione dell'identità per una risorsa.

Nome Tipo Descrizione
principalId

string (uuid)

L'id principale di Azure Active Directory.
tenantId

string (uuid)

L'ID tenant di Azure Active Directory.
type

IdentityType

Tipo di identità. Imposta questo su 'SystemAssigned' per creare e assegnare automaticamente un Azure Active Directory principal per la risorsa.
userAssignedIdentities

<string,  UserIdentity>

ID risorsa delle identità assegnate dall'utente da usare

Server

Oggetto

Un server database SQL di Azure.

Nome Tipo Descrizione
id

string (arm-id)

ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity

ResourceIdentity

L'identità Azure Active Directory del server.
kind

string

Tipo di sql server. Questi sono metadati utilizzati per l'esperienza del portale Azure.
location

string

Posizione geografica in cui risiede la risorsa
name

string

Nome della risorsa
properties.administratorLogin

string

Nome utente amministratore per il server. Una volta creato, non è possibile modificarlo.
properties.administratorLoginPassword

string (password)

Password di accesso dell'amministratore (necessaria per la creazione del server).
properties.administrators

ServerExternalAdministrator

L'amministratore di Azure Active Directory può essere utilizzato durante la creazione del server e per gli aggiornamenti del server, ad eccezione della proprietà azureADOnlyAuthentication. Per aggiornare la proprietà azureADOnlyAuthentication, è necessario usare una singola API.
properties.createMode

ServerCreateMode

Modalità di creazione per il server, gli unici valori validi per questo sono Normale e Ripristino.
properties.externalGovernanceStatus

ExternalGovernanceStatus

Stato della governance esterna.
properties.federatedClientId

string (uuid)

ID client usato per lo scenario cmk tra tenant
properties.fullyQualifiedDomainName

string

Nome di dominio completo del server.
properties.isIPv6Enabled

ServerNetworkAccessFlag

Indica se abilitare o meno il supporto IPv6 per questo server. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'
properties.keyId

string

URI della chiave da usare per la crittografia.
properties.minimalTlsVersion

MinimalTlsVersion

Versione minima di TLS. Valori consentiti: 'Nessuno', 1.0', '1.1', '1.2', '1.3'
properties.primaryUserAssignedIdentityId

string

ID risorsa di un'identità assegnata dall'utente da usare per impostazione predefinita.
properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

Elenco delle connessioni di endpoint privato in un server
properties.publicNetworkAccess

ServerPublicNetworkAccessFlag

Indica se l'accesso all'endpoint pubblico è consentito per questo server. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled' o 'SecuredByPerimeter'
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.retentionDays

integer (int32)

Numero di giorni in cui il server rimarrà eliminato temporaneamente.
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
systemData

systemData

Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
tags

object

Tag di risorsa.
type

string

Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

ServerCreateMode

Enumerazione

Modalità di creazione per il server, gli unici valori validi per questo sono Normale e Ripristino.

Valore Descrizione
Normal

Normale
Restore

Restore

ServerExternalAdministrator

Oggetto

Proprietà di un amministratore di Active Directory.

Nome Tipo Descrizione
administratorType

AdministratorType

Tipo dell'amministratore di sever.
azureADOnlyAuthentication

boolean

Solo Azure Active Directory Autenticazione abilitata.
login

string

Nome di accesso dell'amministratore del server.
principalType

PrincipalType

Tipo di entità dell'amministratore di sever.
sid

string (uuid)

SID (ID oggetto) dell'amministratore del server.
tenantId

string (uuid)

ID tenant dell'amministratore.

ServerNetworkAccessFlag

Enumerazione

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'

Valore Descrizione
Enabled

Enabled
Disabled

Disattivato

ServerPrivateEndpointConnection

Oggetto

Una connessione endpoint privato in un server

Nome Tipo Descrizione
id

string

ID risorsa.
properties

PrivateEndpointConnectionProperties

Proprietà di connessione dell'endpoint privato

ServerPublicNetworkAccessFlag

Enumerazione

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

Valore Descrizione
Enabled

Enabled
Disabled

Disattivato
SecuredByPerimeter

Assicurato da Perimeter

ServerWorkspaceFeature

Enumerazione

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

Valore Descrizione
Connected

Connesso
Disconnected

Scollegato

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string (date-time)

Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

UserIdentity

Oggetto

Azure Active Directory configurazione dell'identità per una risorsa.

Nome Tipo Descrizione
clientId

string (uuid)

L'ID client di Azure Active Directory.
principalId

string (uuid)

L'id principale di Azure Active Directory.