Číst v angličtině

Sdílet prostřednictvím

Servers - List

  • Reference
Služba:
SQL Database
Verze rozhraní API:
2023-08-01

Získá seznam všech serverů v předplatném.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
subscriptionId
 path True

string

ID předplatného, které identifikuje předplatné Azure.
api-version
 query True

string

Verze rozhraní API, která se má použít pro požadavek.
$expand
 query

string

Podřízené prostředky, které se mají zahrnout do odpovědi.

Odpovědi

Name Typ Description
200 OK

ServerListResult

Seznam serverů se úspěšně načetl.
Other Status Codes

ErrorResponse

Chybové odpovědi: ***

  • 404 SubscriptionNotFound – Požadované předplatné nebylo nalezeno.

  • 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

  • 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

List servers
List servers with $expand=administrators/activedirectory

List servers

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
              }
            }
          }
        ]
      }
    }
  ]
}

Definice

Name Description
AdministratorType

Typ správce serveru.
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorDetail

Podrobnosti o chybě.
ErrorResponse

Chybová odpověď
ExternalGovernanceStatus

Stav externích zásad správného řízení
IdentityType

Typ identity. Nastavte ho na SystemAssigned, aby se automaticky vytvořil a přiřadil objekt zabezpečení Azure Active Directory pro daný prostředek.
MinimalTlsVersion

Minimální verze protokolu TLS. Povolené hodnoty: None, 1.0, 1.1, 1.2, 1.2, 1.3
PrincipalType

Hlavní typ správce serveru.
PrivateEndpointConnectionProperties

Vlastnosti připojení privátního koncového bodu
PrivateEndpointProperty
PrivateEndpointProvisioningState

Stav připojení privátního koncového bodu
PrivateLinkServiceConnectionStateActionsRequire

Akce vyžadované pro připojení služby Private Link
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

Stav připojení služby Private Link.
ResourceIdentity

Konfigurace identity Azure Active Directory pro prostředek
Server

Server Azure SQL Database.
ServerExternalAdministrator

Vlastnosti správce služby Active Directory
ServerListResult

Seznam serverů.
ServerNetworkAccessFlag

Určuje, jestli chcete omezit odchozí síťový přístup pro tento server. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno).
ServerPrivateEndpointConnection

Připojení privátního koncového bodu pod serverem
ServerPublicNetworkAccessFlag

Určuje, jestli je pro tento server povolený přístup k veřejnému koncovému bodu nebo ne. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno) nebo SecuredByPerimeter (SecuredByPerimeter).
ServerWorkspaceFeature

Určuje, jestli má existující server vytvořený pracovní prostor a jestli umožňuje připojení z pracovního prostoru.
UserIdentity

Konfigurace identity Azure Active Directory pro prostředek

AdministratorType

Výčet

Typ správce serveru.

Hodnota Description
ActiveDirectory

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby.
details

ErrorDetail[]

Podrobnosti o chybě.
message

string

Chybová zpráva.
target

string

Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

ExternalGovernanceStatus

Výčet

Stav externích zásad správného řízení

Hodnota Description
Disabled
Enabled

IdentityType

Výčet

Typ identity. Nastavte ho na SystemAssigned, aby se automaticky vytvořil a přiřadil objekt zabezpečení Azure Active Directory pro daný prostředek.

Hodnota Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Výčet

Minimální verze protokolu TLS. Povolené hodnoty: None, 1.0, 1.1, 1.2, 1.2, 1.3

Hodnota Description
1.0
1.1
1.2
1.3
None

PrincipalType

Výčet

Hlavní typ správce serveru.

Hodnota Description
Application
Group
User

PrivateEndpointConnectionProperties

Objekt

Vlastnosti připojení privátního koncového bodu

Name Typ Description
groupIds

string[]

ID skupin
privateEndpoint

PrivateEndpointProperty

Privátní koncový bod, ke kterému připojení patří.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Stav připojení privátního koncového bodu
provisioningState

PrivateEndpointProvisioningState

Stav připojení privátního koncového bodu

PrivateEndpointProperty

Objekt
Name Typ Description
id

string

ID prostředku privátního koncového bodu

PrivateEndpointProvisioningState

Výčet

Stav připojení privátního koncového bodu

Hodnota Description
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Výčet

Akce vyžadované pro připojení služby Private Link

Hodnota Description
None

PrivateLinkServiceConnectionStateProperty

Objekt
Name Typ Description
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

Akce vyžadované pro připojení služby Private Link
description

string

Popis připojení služby Private Link.
status

PrivateLinkServiceConnectionStateStatus

Stav připojení služby Private Link.

PrivateLinkServiceConnectionStateStatus

Výčet

Stav připojení služby Private Link.

Hodnota Description
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Objekt

Konfigurace identity Azure Active Directory pro prostředek

Name Typ Description
principalId

string (uuid)

ID objektu zabezpečení Azure Active Directory.
tenantId

string (uuid)

ID tenanta Azure Active Directory.
type

IdentityType

Typ identity. Nastavte ho na SystemAssigned, aby se automaticky vytvořil a přiřadil objekt zabezpečení Azure Active Directory pro daný prostředek.
userAssignedIdentities

<string,  UserIdentity>

ID prostředků identit přiřazených uživatelem, které se mají použít

Server

Objekt

Server Azure SQL Database.

Name Typ Description
id

string

ID prostředku.
identity

ResourceIdentity

Identita azure Active Directory serveru.
kind

string

Druh sql serveru. Toto jsou metadata používaná pro prostředí webu Azure Portal.
location

string

Umístění prostředku
name

string

Název prostředku
properties.administratorLogin

string

Uživatelské jméno správce pro server. Po vytvoření se nedá změnit.
properties.administratorLoginPassword

string

Přihlašovací heslo správce (vyžaduje se k vytvoření serveru).
properties.administrators

ServerExternalAdministrator

Správce azure Active Directory serveru. Tuto možnost lze použít pouze v době vytvoření serveru. Pokud se používá pro aktualizaci serveru, bude ignorován nebo dojde k chybě. Pro aktualizace bude potřeba použít jednotlivá rozhraní API.
properties.externalGovernanceStatus

ExternalGovernanceStatus

Stav externích zásad správného řízení
properties.federatedClientId

string (uuid)

ID klienta používaného pro scénář cmk napříč tenanty
properties.fullyQualifiedDomainName

string

Plně kvalifikovaný název domény serveru.
properties.isIPv6Enabled

ServerNetworkAccessFlag

Jestli chcete povolit podporu protokolu IPv6 pro tento server, nebo ne. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno).
properties.keyId

string

Identifikátor URI klíče CMK, který se má použít k šifrování.
properties.minimalTlsVersion

MinimalTlsVersion

Minimální verze protokolu TLS. Povolené hodnoty: None, 1.0, 1.1, 1.2, 1.2, 1.3
properties.primaryUserAssignedIdentityId

string

ID prostředku identity přiřazené uživatelem, které se má použít ve výchozím nastavení.
properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

Seznam připojení privátních koncových bodů na serveru
properties.publicNetworkAccess

ServerPublicNetworkAccessFlag

Určuje, jestli je pro tento server povolený přístup k veřejnému koncovému bodu nebo ne. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno) nebo SecuredByPerimeter (SecuredByPerimeter).
properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

Určuje, jestli chcete omezit odchozí síťový přístup pro tento server. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno).
properties.state

string

Stav serveru.
properties.version

string

Verze serveru.
properties.workspaceFeature

ServerWorkspaceFeature

Určuje, jestli má existující server vytvořený pracovní prostor a jestli umožňuje připojení z pracovního prostoru.
tags

object

Značky prostředků
type

string

Typ prostředku.

ServerExternalAdministrator

Objekt

Vlastnosti správce služby Active Directory

Name Typ Description
administratorType

AdministratorType

Typ správce serveru.
azureADOnlyAuthentication

boolean

Je povoleno pouze ověřování Azure Active Directory.
login

string

Přihlašovací jméno správce serveru.
principalType

PrincipalType

Hlavní typ správce serveru.
sid

string (uuid)

IDENTIFIKÁTOR SID (ID objektu) správce serveru.
tenantId

string (uuid)

ID tenanta správce.

ServerListResult

Objekt

Seznam serverů.

Name Typ Description
nextLink

string

Odkaz na načtení další stránky výsledků
value

Server[]

Pole výsledků

ServerNetworkAccessFlag

Výčet

Určuje, jestli chcete omezit odchozí síťový přístup pro tento server. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno).

Hodnota Description
Disabled
Enabled

ServerPrivateEndpointConnection

Objekt

Připojení privátního koncového bodu pod serverem

Name Typ Description
id

string

ID prostředku.
properties

PrivateEndpointConnectionProperties

Vlastnosti připojení privátního koncového bodu

ServerPublicNetworkAccessFlag

Výčet

Určuje, jestli je pro tento server povolený přístup k veřejnému koncovému bodu nebo ne. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno) nebo SecuredByPerimeter (SecuredByPerimeter).

Hodnota Description
Disabled
Enabled
SecuredByPerimeter

ServerWorkspaceFeature

Výčet

Určuje, jestli má existující server vytvořený pracovní prostor a jestli umožňuje připojení z pracovního prostoru.

Hodnota Description
Connected
Disconnected

UserIdentity

Objekt

Konfigurace identity Azure Active Directory pro prostředek

Name Typ Description
clientId

string (uuid)

ID klienta Azure Active Directory.
principalId

string (uuid)

ID objektu zabezpečení Azure Active Directory.