Servers - List

Referentie

Service:: SQL Database

API-versie:: 2023-08-01

Hiermee haalt u een lijst op van alle servers in het abonnement.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers?api-version=2023-08-01

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
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	ServerListResult	De lijst met servers is opgehaald.
Other Status Codes	ErrorResponse	Foutreacties: *** 404 SubscriptionNotFound - Het aangevraagde abonnement 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.

Name

Type

Description

200 OK

ServerListResult

De lijst met servers is opgehaald.

Other Status Codes

ErrorResponse

Foutreacties: ***

404 SubscriptionNotFound - Het aangevraagde abonnement 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

List servers

List servers with $expand=administrators/activedirectory

List servers

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "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"
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
      "name": "sqlcrudtest-6661",
      "type": "Microsoft.Sql/servers",
      "location": "japaneast",
      "kind": "v12.0",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-6661.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"
              }
            }
          }
        ]
      }
    }
  ]
}

List servers with $expand=administrators/activedirectory

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "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"
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
      "name": "sqlcrudtest-6661",
      "type": "Microsoft.Sql/servers",
      "location": "japaneast",
      "kind": "v12.0",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-6661.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"
              }
            }
          }
        ]
      }
    }
  ]
}

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.
ServerExternalAdministrator	Eigenschappen van een Active Directory-beheerder.
ServerListResult	Een lijst met servers.
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

Inventarisatie

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

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ExternalGovernanceStatus

Inventarisatie

Status van extern beheer.

Waarde	Description
Disabled
Enabled

IdentityType

Inventarisatie

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
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Inventarisatie

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

Waarde	Description
1.0
1.1
1.2
1.3
None

PrincipalType

Inventarisatie

Principal-type van de serverbeheerder.

Waarde	Description
Application
Group
User

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

Inventarisatie

Status van de privé-eindpuntverbinding.

Waarde	Description
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Inventarisatie

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

Inventarisatie

De verbindingsstatus van de Private Link-service.

Waarde	Description
Approved
Disconnected
Pending
Rejected

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 van de server. Dit kan alleen worden gebruikt tijdens het maken van de server. Als deze wordt gebruikt voor het bijwerken van de server, wordt deze genegeerd of resulteert dit in een fout. Voor updates moeten afzonderlijke API's worden gebruikt.
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.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	Resourcetype.

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.

ServerListResult

Object

Een lijst met servers.

Name	Type	Description
nextLink	string	Koppeling om de volgende pagina met resultaten op te halen.
value	Server[]	Matrix met resultaten.

ServerNetworkAccessFlag

Inventarisatie

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

ServerPrivateEndpointConnection

Object

Een privé-eindpuntverbinding onder een server

Name	Type	Description
id	string	Resource-id.
properties	PrivateEndpointConnectionProperties	Eigenschappen van privé-eindpuntverbinding

ServerPublicNetworkAccessFlag

Inventarisatie

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

ServerWorkspaceFeature

Inventarisatie

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.

Delen via

Servers - List

URI-parameters

Antwoorden

Voorbeelden

List servers

Voorbeeldaanvraag

Voorbeeldrespons

List servers with $expand=administrators/activedirectory

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

UserIdentity

Aanvullende resources