Delen via

Servers - Get

Service:
SQL Database
API-versie:
2025-01-01

Haalt een server op.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName
 path True

string

De naam van de server.
subscriptionId
 path True

string

De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version
 query True

string

De API-versie die moet worden gebruikt voor de aanvraag.
$expand
 query

string

De onderliggende resources die moeten worden opgenomen in het antwoord.

Antwoorden

Name Type Description
200 OK

Server

De opgegeven server is opgehaald.
Other Status Codes

ErrorResponse

Foutreacties: ***

  • 404 SubscriptionNotFound - Het aangevraagde abonnement is niet gevonden.

  • 404 ResourceNotFound : de aangevraagde resource is niet gevonden.

  • 429 SubscriptionTooManyRequests : aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.

  • 503 TooManyRequests : aanvragen die buiten het maximum aantal aanvragen kunnen worden verwerkt door beschikbare resources.

Voorbeelden

Get server
Get server with $expand=administrators/activedirectory

Get server

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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",
    "retentionDays": 7,
    "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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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",
    "retentionDays": 7,
    "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"
          }
        }
      }
    ]
  }
}

Definities

Name Description
AdministratorType

Type van de serverbeheerder.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie
ExternalGovernanceStatus

Status van extern beheer.
IdentityType

Het identiteitstype. Stel dit in op SystemAssigned om automatisch een Azure Active Directory-principal voor de resource te maken en toe te wijzen.
MinimalTlsVersion

Minimale TLS-versie. Toegestane waarden: 'None', 1.0', '1.1', '1.2', '1.3'
PrincipalType

Principal-type van de serverbeheerder.
PrivateEndpointConnectionProperties

Eigenschappen van een privé-eindpuntverbinding.
PrivateEndpointProperty
PrivateEndpointProvisioningState

Status van de privé-eindpuntverbinding.
PrivateLinkServiceConnectionStateActionsRequire

De acties die nodig zijn voor de private link-serviceverbinding.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

De verbindingsstatus van de Private Link-service.
ResourceIdentity

Azure Active Directory-identiteitsconfiguratie voor een resource.
Server

Een Azure SQL Database-server.
ServerCreateMode

Maakmodus voor server, alleen geldige waarden hiervoor zijn Normaal en Herstellen.
ServerExternalAdministrator

Eigenschappen van een Active Directory-beheerder.
ServerNetworkAccessFlag

Hiermee wordt aangegeven of uitgaande netwerktoegang voor deze server al dan niet wordt beperkt. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn
ServerPrivateEndpointConnection

Een privé-eindpuntverbinding onder een server
ServerPublicNetworkAccessFlag

Of openbare eindpunttoegang wel of niet is toegestaan voor deze server. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' of 'SecuredByPerimeter' zijn
ServerWorkspaceFeature

Of er al dan niet een bestaande server een werkruimte is gemaakt en of er verbinding vanuit de werkruimte is toegestaan
UserIdentity

Azure Active Directory-identiteitsconfiguratie voor een resource.

AdministratorType

Opsomming

Type van de serverbeheerder.

Waarde Description
ActiveDirectory

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoelwit.

ErrorResponse

Object

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

ExternalGovernanceStatus

Opsomming

Status van extern beheer.

Waarde Description
Enabled
Disabled

IdentityType

Opsomming

Het identiteitstype. Stel dit in op SystemAssigned om automatisch een Azure Active Directory-principal voor de resource te maken en toe te wijzen.

Waarde Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MinimalTlsVersion

Opsomming

Minimale TLS-versie. Toegestane waarden: 'None', 1.0', '1.1', '1.2', '1.3'

Waarde Description
None
1.0
1.1
1.2
1.3

PrincipalType

Opsomming

Principal-type van de serverbeheerder.

Waarde Description
User
Group
Application

PrivateEndpointConnectionProperties

Object

Eigenschappen van een privé-eindpuntverbinding.

Name Type Description
groupIds

string[]

Groeps-id's.
privateEndpoint

PrivateEndpointProperty

Privé-eindpunt waartoe de verbinding behoort.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Verbindingsstatus van de privé-eindpuntverbinding.
provisioningState

PrivateEndpointProvisioningState

Status van de privé-eindpuntverbinding.

PrivateEndpointProperty

Object
Name Type Description
id

string

Resource-id van het privé-eindpunt.

PrivateEndpointProvisioningState

Opsomming

Status van de privé-eindpuntverbinding.

Waarde Description
Approving
Ready
Dropping
Failed
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Opsomming

De acties die nodig zijn voor de private link-serviceverbinding.

Waarde Description
None

PrivateLinkServiceConnectionStateProperty

Object
Name Type Description
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

De acties die nodig zijn voor de private link-serviceverbinding.
description

string

De beschrijving van de private link-serviceverbinding.
status

PrivateLinkServiceConnectionStateStatus

De verbindingsstatus van de Private Link-service.

PrivateLinkServiceConnectionStateStatus

Opsomming

De verbindingsstatus van de Private Link-service.

Waarde Description
Approved
Pending
Rejected
Disconnected

ResourceIdentity

Object

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name Type Description
principalId

string (uuid)

De principal-id van Azure Active Directory.
tenantId

string (uuid)

De tenant-id van Azure Active Directory.
type

IdentityType

Het identiteitstype. Stel dit in op SystemAssigned om automatisch een Azure Active Directory-principal voor de resource te maken en toe te wijzen.
userAssignedIdentities

<string,  UserIdentity>

De resource-id's van de door de gebruiker toegewezen identiteiten die moeten worden gebruikt

Server

Object

Een Azure SQL Database-server.

Name Type Description
id

string

Resource-ID.
identity

ResourceIdentity

De Azure Active Directory-identiteit van de server.
kind

string

Soort SQL-server. Dit zijn metagegevens die worden gebruikt voor de Azure Portal-ervaring.
location

string

Resourcelocatie.
name

string

Resourcenaam.
properties.administratorLogin

string

Gebruikersnaam van de beheerder voor de server. Zodra het is gemaakt, kan deze niet meer worden gewijzigd.
properties.administratorLoginPassword

string

Het aanmeldingswachtwoord van de beheerder (vereist voor het maken van de server).
properties.administrators

ServerExternalAdministrator

De Azure Active Directory-beheerder kan worden gebruikt tijdens het maken van de server en voor serverupdates, met uitzondering van de eigenschap azureADOnlyAuthentication. Als u de eigenschap azureADOnlyAuthentication wilt bijwerken, moet een afzonderlijke API worden gebruikt.
properties.createMode

ServerCreateMode

Maakmodus voor server, alleen geldige waarden hiervoor zijn Normaal en Herstellen.
properties.externalGovernanceStatus

ExternalGovernanceStatus

Status van extern beheer.
properties.federatedClientId

string (uuid)

De client-id die wordt gebruikt voor CMK-scenario voor meerdere tenants
properties.fullyQualifiedDomainName

string

De volledig gekwalificeerde domeinnaam van de server.
properties.isIPv6Enabled

ServerNetworkAccessFlag

Of iPv6-ondersteuning voor deze server al dan niet moet worden ingeschakeld. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn
properties.keyId

string

Een CMK-URI van de sleutel die moet worden gebruikt voor versleuteling.
properties.minimalTlsVersion

MinimalTlsVersion

Minimale TLS-versie. Toegestane waarden: 'None', 1.0', '1.1', '1.2', '1.3'
properties.primaryUserAssignedIdentityId

string

De resource-id van een door de gebruiker toegewezen identiteit die standaard moet worden gebruikt.
properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

Lijst met privé-eindpuntverbindingen op een server
properties.publicNetworkAccess

ServerPublicNetworkAccessFlag

Of openbare eindpunttoegang wel of niet is toegestaan voor deze server. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' of 'SecuredByPerimeter' zijn
properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

Hiermee wordt aangegeven of uitgaande netwerktoegang voor deze server al dan niet wordt beperkt. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn
properties.retentionDays

integer (int32)

Het aantal dagen dat deze server voorlopig verwijderd blijft.
properties.state

string

De status van de server.
properties.version

string

De versie van de server.
properties.workspaceFeature

ServerWorkspaceFeature

Of er al dan niet een bestaande server een werkruimte is gemaakt en of er verbinding vanuit de werkruimte is toegestaan
tags

object

Resourcetags.
type

string

Type bron

ServerCreateMode

Opsomming

Maakmodus voor server, alleen geldige waarden hiervoor zijn Normaal en Herstellen.

Waarde Description
Normal
Restore

ServerExternalAdministrator

Object

Eigenschappen van een Active Directory-beheerder.

Name Type Description
administratorType

AdministratorType

Type van de serverbeheerder.
azureADOnlyAuthentication

boolean

Alleen azure Active Directory-verificatie ingeschakeld.
login

string

Aanmeldingsnaam van de serverbeheerder.
principalType

PrincipalType

Principal-type van de serverbeheerder.
sid

string (uuid)

SID (object-id) van de serverbeheerder.
tenantId

string (uuid)

Tenant-id van de beheerder.

ServerNetworkAccessFlag

Opsomming

Hiermee wordt aangegeven of uitgaande netwerktoegang voor deze server al dan niet wordt beperkt. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn

Waarde Description
Enabled
Disabled

ServerPrivateEndpointConnection

Object

Een privé-eindpuntverbinding onder een server

Name Type Description
id

string

Resource-ID.
properties

PrivateEndpointConnectionProperties

Eigenschappen van privé-eindpuntverbinding

ServerPublicNetworkAccessFlag

Opsomming

Of openbare eindpunttoegang wel of niet is toegestaan voor deze server. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' of 'SecuredByPerimeter' zijn

Waarde Description
Enabled
Disabled
SecuredByPerimeter

ServerWorkspaceFeature

Opsomming

Of er al dan niet een bestaande server een werkruimte is gemaakt en of er verbinding vanuit de werkruimte is toegestaan

Waarde Description
Connected
Disconnected

UserIdentity

Object

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name Type Description
clientId

string (uuid)

De Azure Active Directory-client-id.
principalId

string (uuid)

De principal-id van Azure Active Directory.