Condividi tramite

Servers - Get

  • Riferimento
Servizio:
SQL Database
Versione API:
2023-08-01

Ottiene un server.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
 path True

string

Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager 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

ErrorResponse

Risposte di errore:

  • 404 SubscriptionNotFound - La sottoscrizione richiesta non è stata trovata.

  • 404 ResourceNotFound: la risorsa richiesta non è stata trovata.

  • 429 SubscriptionTooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

  • 503 TooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

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=2023-08-01

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",
    "isIPv6Enabled": "Enabled",
    "externalGovernanceStatus": "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

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

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",
    "isIPv6Enabled": "Enabled",
    "externalGovernanceStatus": "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 dell'amministratore di sever.
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à. Impostare questa opzione su "SystemAssigned" per creare e assegnare automaticamente un'entità di azure Active Directory 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

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

Un server di database SQL di Azure.
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
UserIdentity

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

AdministratorType

Enumerazione

Tipo dell'amministratore di sever.

Valore Descrizione
ActiveDirectory

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Object

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

Object

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

ExternalGovernanceStatus

Enumerazione

Stato della governance esterna.

Valore Descrizione
Disabled
Enabled

IdentityType

Enumerazione

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

MinimalTlsVersion

Enumerazione

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

Valore Descrizione
1.0
1.1
1.2
1.3
None

PrincipalType

Enumerazione

Tipo di entità dell'amministratore di sever.

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

Enumerazione

Stato della connessione dell'endpoint privato.

Valore Descrizione
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumerazione

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

PrivateLinkServiceConnectionStateStatus

Enumerazione

Stato della connessione al servizio 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 (uuid)

ID dell'entità di sicurezza di Azure Active Directory.
tenantId

string (uuid)

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 SQL di Azure.

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 del portale di Azure.
location

string

Percorso della risorsa.
name

string

Nome risorsa.
properties.administratorLogin

string

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

string

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

ServerExternalAdministrator

Amministratore di Azure Active Directory del server. Questa operazione può essere usata solo in fase di creazione del server. Se usato per l'aggiornamento del server, verrà ignorato o verrà generato un errore. Per gli aggiornamenti è necessario usare le singole API.
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.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 di risorsa.
type

string

Tipo di risorsa.

ServerExternalAdministrator

Object

Proprietà di un amministratore di Active Directory.

Nome Tipo Descrizione
administratorType

AdministratorType

Tipo dell'amministratore di sever.
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 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
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

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
Disabled
Enabled
SecuredByPerimeter

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
Disconnected

UserIdentity

Object

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

Nome Tipo Descrizione
clientId

string (uuid)

ID client di Azure Active Directory.
principalId

string (uuid)

ID dell'entità di sicurezza di Azure Active Directory.