Udostępnij za pośrednictwem

Servers - Get

  • Odwołanie
Usługa:
SQL Database
Wersja interfejsu API:
2023-08-01

Pobiera serwer.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
 path True

string

Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
serverName
 path True

string

Nazwa serwera.
subscriptionId
 path True

string

Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version
 query True

string

Wersja interfejsu API do użycia dla żądania.
$expand
 query

string

Zasoby podrzędne do uwzględnienia w odpowiedzi.

Odpowiedzi

Nazwa Typ Opis
200 OK

Server

Pomyślnie pobrano określony serwer.
Other Status Codes

ErrorResponse

Odpowiedzi na błędy: ***

  • 404 SubscriptionNotFound — żądana subskrypcja nie została znaleziona.

  • 404 ResourceNotFound — żądany zasób nie został znaleziony.

  • 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby.

  • 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

Przykłady

Get server
Get server with $expand=administrators/activedirectory

Get server

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
          }
        }
      }
    ]
  }
}

Definicje

Nazwa Opis
AdministratorType

Typ administratora serwera.
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
ExternalGovernanceStatus

Stan nadzoru zewnętrznego.
IdentityType

Typ tożsamości. Ustaw wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.
MinimalTlsVersion

Minimalna wersja protokołu TLS. Dozwolone wartości: "None", 1.0", "1.1", "1.2", "1.3"
PrincipalType

Typ podmiotu zabezpieczeń administratora serwera.
PrivateEndpointConnectionProperties

Właściwości połączenia prywatnego punktu końcowego.
PrivateEndpointProperty
PrivateEndpointProvisioningState

Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionStateActionsRequire

Akcje wymagane do nawiązania połączenia z usługą private link.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

Stan połączenia usługi private link.
ResourceIdentity

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.
Server

Serwer usługi Azure SQL Database.
ServerExternalAdministrator

Właściwości administratora usługi Active Directory.
ServerNetworkAccessFlag

Określa, czy ograniczyć dostęp do sieci wychodzącej dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
ServerPrivateEndpointConnection

Połączenie prywatnego punktu końcowego na serwerze
ServerPublicNetworkAccessFlag

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone" lub "SecuredByPerimeter"
ServerWorkspaceFeature

Czy istniejący serwer ma utworzony obszar roboczy i czy zezwala na połączenie z obszaru roboczego
UserIdentity

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

AdministratorType

Wyliczanie

Typ administratora serwera.

Wartość Opis
ActiveDirectory

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

ExternalGovernanceStatus

Wyliczanie

Stan nadzoru zewnętrznego.

Wartość Opis
Disabled
Enabled

IdentityType

Wyliczanie

Typ tożsamości. Ustaw wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.

Wartość Opis
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Wyliczanie

Minimalna wersja protokołu TLS. Dozwolone wartości: "None", 1.0", "1.1", "1.2", "1.3"

Wartość Opis
1.0
1.1
1.2
1.3
None

PrincipalType

Wyliczanie

Typ podmiotu zabezpieczeń administratora serwera.

Wartość Opis
Application
Group
User

PrivateEndpointConnectionProperties

Objekt

Właściwości połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
groupIds

string[]

Identyfikatory grup.
privateEndpoint

PrivateEndpointProperty

Prywatny punkt końcowy, do którego należy połączenie.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Stan połączenia prywatnego punktu końcowego.
provisioningState

PrivateEndpointProvisioningState

Stan połączenia prywatnego punktu końcowego.

PrivateEndpointProperty

Objekt
Nazwa Typ Opis
id

string

Identyfikator zasobu prywatnego punktu końcowego.

PrivateEndpointProvisioningState

Wyliczanie

Stan połączenia prywatnego punktu końcowego.

Wartość Opis
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Wyliczanie

Akcje wymagane do nawiązania połączenia z usługą private link.

Wartość Opis
None

PrivateLinkServiceConnectionStateProperty

Objekt
Nazwa Typ Opis
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

Akcje wymagane do nawiązania połączenia z usługą private link.
description

string

Opis połączenia usługi private link.
status

PrivateLinkServiceConnectionStateStatus

Stan połączenia usługi private link.

PrivateLinkServiceConnectionStateStatus

Wyliczanie

Stan połączenia usługi private link.

Wartość Opis
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Objekt

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa Typ Opis
principalId

string (uuid)

Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory.
tenantId

string (uuid)

Identyfikator dzierżawy usługi Azure Active Directory.
type

IdentityType

Typ tożsamości. Ustaw wartość "SystemAssigned", aby automatycznie utworzyć i przypisać jednostkę usługi Azure Active Directory dla zasobu.
userAssignedIdentities

<string,  UserIdentity>

Identyfikatory zasobów tożsamości przypisanych przez użytkownika do użycia

Server

Objekt

Serwer usługi Azure SQL Database.

Nazwa Typ Opis
id

string

Identyfikator zasobu.
identity

ResourceIdentity

Tożsamość usługi Azure Active Directory serwera.
kind

string

Rodzaj programu SQL Server. Są to metadane używane w środowisku witryny Azure Portal.
location

string

Lokalizacja zasobu.
name

string

Nazwa zasobu.
properties.administratorLogin

string

Nazwa użytkownika administratora serwera. Po utworzeniu nie można go zmienić.
properties.administratorLoginPassword

string

Hasło logowania administratora (wymagane do utworzenia serwera).
properties.administrators

ServerExternalAdministrator

Administrator usługi Azure Active Directory serwera. Może to być używane tylko w czasie tworzenia serwera. Jeśli jest używana do aktualizacji serwera, zostanie ona zignorowana lub spowoduje błąd. W przypadku aktualizacji należy użyć poszczególnych interfejsów API.
properties.externalGovernanceStatus

ExternalGovernanceStatus

Stan nadzoru zewnętrznego.
properties.federatedClientId

string (uuid)

Identyfikator klienta używany w scenariuszu cmK między dzierżawami
properties.fullyQualifiedDomainName

string

W pełni kwalifikowana nazwa domeny serwera.
properties.isIPv6Enabled

ServerNetworkAccessFlag

Czy włączyć obsługę protokołu IPv6 dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
properties.keyId

string

Identyfikator URI klucza cmK do użycia na potrzeby szyfrowania.
properties.minimalTlsVersion

MinimalTlsVersion

Minimalna wersja protokołu TLS. Dozwolone wartości: "None", 1.0", "1.1", "1.2", "1.3"
properties.primaryUserAssignedIdentityId

string

Identyfikator zasobu tożsamości przypisanej przez użytkownika domyślnie używany.
properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

Lista połączeń prywatnych punktów końcowych na serwerze
properties.publicNetworkAccess

ServerPublicNetworkAccessFlag

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone" lub "SecuredByPerimeter"
properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

Określa, czy ograniczyć dostęp do sieci wychodzącej dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
properties.state

string

Stan serwera.
properties.version

string

Wersja serwera.
properties.workspaceFeature

ServerWorkspaceFeature

Czy istniejący serwer ma utworzony obszar roboczy i czy zezwala na połączenie z obszaru roboczego
tags

object

Tagi zasobów.
type

string

Typ zasobu.

ServerExternalAdministrator

Objekt

Właściwości administratora usługi Active Directory.

Nazwa Typ Opis
administratorType

AdministratorType

Typ administratora serwera.
azureADOnlyAuthentication

boolean

Włączono tylko uwierzytelnianie usługi Azure Active Directory.
login

string

Nazwa logowania administratora serwera.
principalType

PrincipalType

Typ podmiotu zabezpieczeń administratora serwera.
sid

string (uuid)

Identyfikator SID (identyfikator obiektu) administratora serwera.
tenantId

string (uuid)

Identyfikator dzierżawy administratora.

ServerNetworkAccessFlag

Wyliczanie

Określa, czy ograniczyć dostęp do sieci wychodzącej dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"

Wartość Opis
Disabled
Enabled

ServerPrivateEndpointConnection

Objekt

Połączenie prywatnego punktu końcowego na serwerze

Nazwa Typ Opis
id

string

Identyfikator zasobu.
properties

PrivateEndpointConnectionProperties

Właściwości połączenia prywatnego punktu końcowego

ServerPublicNetworkAccessFlag

Wyliczanie

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone" lub "SecuredByPerimeter"

Wartość Opis
Disabled
Enabled
SecuredByPerimeter

ServerWorkspaceFeature

Wyliczanie

Czy istniejący serwer ma utworzony obszar roboczy i czy zezwala na połączenie z obszaru roboczego

Wartość Opis
Connected
Disconnected

UserIdentity

Objekt

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa Typ Opis
clientId

string (uuid)

Identyfikator klienta usługi Azure Active Directory.
principalId

string (uuid)

Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory.