Servers - Get

Pobiera informacje o serwerze.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}?api-version=2022-12-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serverName
path True

string

Nazwa serwera.

Regex pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

Server

OK

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ServerGet
ServerGetWithVnet

ServerGet

Sample Request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1?api-version=2022-12-01

Sample Response

{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00"
    },
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1",
  "name": "pgtestsvc1",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

ServerGetWithVnet

Sample Request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2022-12-01

Sample Response

{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Definicje

Nazwa Opis
activeDirectoryAuthEnum

W przypadku włączenia uwierzytelniania usługi Azure Active Directory jest włączone.

ArmServerKeyType

Typ szyfrowania danych do przedstawienia, czy jest zarządzany przez system, a usługa Azure Key Vault.

AuthConfig

Właściwości AuthConfig serwera.

Backup

Właściwości kopii zapasowej serwera.

createdByType

Typ tożsamości, która utworzyła zasób.

CreateMode

Tryb tworzenia nowego serwera PostgreSQL.

DataEncryption

Właściwości szyfrowania danych serwera.

ErrorAdditionalInfo

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

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

GeoRedundantBackupEnum

Wartość wskazująca, czy na serwerze jest włączona Geo-Redundant kopia zapasowa.

HighAvailability

Właściwości wysokiej dostępności serwera.

HighAvailabilityMode

Tryb wysokiej dostępności serwera.

IdentityType

typy tożsamości skojarzonych z tym zasobem; obecnie ograniczone do parametru "None and UserAssigned"

MaintenanceWindow

Właściwości okna obsługi serwera.

Network

Właściwości sieci serwera. Ta właściwość sieci jest wymagana do przekazania tylko w przypadku, gdy serwer ma być serwerem dostępu prywatnego.

passwordAuthEnum

W przypadku włączenia uwierzytelniania haseł jest włączone.

ReplicationRole

Rola replikacji serwera

Server

Reprezentuje serwer.

ServerHAState

Stan serwera wysokiej dostępności, który jest widoczny dla użytkownika.

ServerPublicNetworkAccessState

dostęp do sieci publicznej jest włączony lub nie

ServerState

Stan serwera, który jest widoczny dla użytkownika.

ServerVersion

Wersja serwera PostgreSQL.

Sku

Jednostka SKU (warstwa cenowa) serwera.

SkuTier

Warstwa konkretnej jednostki SKU, np. z możliwością rozszerzenia.

Storage

Właściwości magazynu serwera.

systemData

Metadane systemowe odnoszące się do tego zasobu.

UserAssignedIdentity

Opisuje tożsamość aplikacji.

UserIdentity

Opisuje tożsamość przypisaną przez jednego użytkownika skojarzona z aplikacją.

activeDirectoryAuthEnum

W przypadku włączenia uwierzytelniania usługi Azure Active Directory jest włączone.

Nazwa Typ Opis
Disabled

string

Enabled

string

ArmServerKeyType

Typ szyfrowania danych do przedstawienia, czy jest zarządzany przez system, a usługa Azure Key Vault.

Nazwa Typ Opis
AzureKeyVault

string

SystemManaged

string

AuthConfig

Właściwości AuthConfig serwera.

Nazwa Typ Wartość domyślna Opis
activeDirectoryAuth

activeDirectoryAuthEnum

W przypadku włączenia uwierzytelniania usługi Azure Active Directory jest włączone.

passwordAuth

passwordAuthEnum

Enabled

W przypadku włączenia uwierzytelniania haseł jest włączone.

tenantId

string

Identyfikator dzierżawy serwera.

Backup

Właściwości kopii zapasowej serwera.

Nazwa Typ Wartość domyślna Opis
backupRetentionDays

integer

7

Dni przechowywania kopii zapasowej serwera.

earliestRestoreDate

string

Najwcześniejszy format punktu przywracania (format ISO8601) dla serwera.

geoRedundantBackup

GeoRedundantBackupEnum

Disabled

Wartość wskazująca, czy na serwerze jest włączona Geo-Redundant kopia zapasowa.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

CreateMode

Tryb tworzenia nowego serwera PostgreSQL.

Nazwa Typ Opis
Create

string

Default

string

GeoRestore

string

PointInTimeRestore

string

Replica

string

Update

string

DataEncryption

Właściwości szyfrowania danych serwera.

Nazwa Typ Opis
primaryKeyURI

string

Identyfikator URI klucza szyfrowania danych dla serwera podstawowego.

primaryUserAssignedIdentityId

string

Identyfikator zasobu tożsamości przypisanej przez użytkownika, która ma być używana do szyfrowania danych na serwerze podstawowym.

type

ArmServerKeyType

Typ szyfrowania danych do przedstawienia, czy jest zarządzany przez system, a usługa Azure Key Vault.

ErrorAdditionalInfo

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

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

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

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt error.

GeoRedundantBackupEnum

Wartość wskazująca, czy na serwerze jest włączona Geo-Redundant kopia zapasowa.

Nazwa Typ Opis
Disabled

string

Enabled

string

HighAvailability

Właściwości wysokiej dostępności serwera.

Nazwa Typ Wartość domyślna Opis
mode

HighAvailabilityMode

Disabled

Tryb wysokiej dostępności serwera.

standbyAvailabilityZone

string

informacje o strefie dostępności rezerwowego.

state

ServerHAState

Stan serwera wysokiej dostępności, który jest widoczny dla użytkownika.

HighAvailabilityMode

Tryb wysokiej dostępności serwera.

Nazwa Typ Opis
Disabled

string

SameZone

string

ZoneRedundant

string

IdentityType

typy tożsamości skojarzonych z tym zasobem; obecnie ograniczone do parametru "None and UserAssigned"

Nazwa Typ Opis
None

string

UserAssigned

string

MaintenanceWindow

Właściwości okna obsługi serwera.

Nazwa Typ Wartość domyślna Opis
customWindow

string

Disabled

wskazuje, czy okno niestandardowe jest włączone, czy wyłączone

dayOfWeek

integer

0

dzień tygodnia dla okna obsługi

startHour

integer

0

godzina rozpoczęcia okna obsługi

startMinute

integer

0

minuta rozpoczęcia okna obsługi

Network

Właściwości sieci serwera. Ta właściwość sieci jest wymagana do przekazania tylko w przypadku, gdy serwer ma być serwerem dostępu prywatnego.

Nazwa Typ Opis
delegatedSubnetResourceId

string

Identyfikator zasobu arm delegowanej podsieci. Jest to wymagane do przekazania podczas tworzenia, jeśli chcemy, aby serwer był wstrzykiwany do sieci wirtualnej, tj. serwer dostępu prywatnego. Podczas aktualizacji przekaż tę wartość tylko wtedy, gdy chcemy zaktualizować wartość strefy Prywatna strefa DNS.

privateDnsZoneArmResourceId

string

Identyfikator zasobu arm prywatnej strefy DNS. Jest to wymagane do przekazania podczas tworzenia, jeśli chcemy, aby serwer był wstrzykiwany do sieci wirtualnej, tj. serwer dostępu prywatnego. Podczas aktualizacji przekaż tę wartość tylko wtedy, gdy chcemy zaktualizować wartość strefy Prywatna strefa DNS.

publicNetworkAccess

ServerPublicNetworkAccessState

dostęp do sieci publicznej jest włączony lub nie

passwordAuthEnum

W przypadku włączenia uwierzytelniania haseł jest włączone.

Nazwa Typ Opis
Disabled

string

Enabled

string

ReplicationRole

Rola replikacji serwera

Nazwa Typ Opis
AsyncReplica

string

GeoAsyncReplica

string

None

string

Primary

string

Server

Reprezentuje serwer.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

UserAssignedIdentity

Opisuje tożsamość aplikacji.

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties.administratorLogin

string

Nazwa logowania administratora serwera. Można określić tylko wtedy, gdy serwer jest tworzony (i jest wymagany do utworzenia).

properties.administratorLoginPassword

string

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

properties.authConfig

AuthConfig

Właściwości AuthConfig serwera.

properties.availabilityZone

string

informacje o strefie dostępności serwera.

properties.backup

Backup

Właściwości kopii zapasowej serwera.

properties.createMode

CreateMode

Tryb tworzenia nowego serwera PostgreSQL.

properties.dataEncryption

DataEncryption

Właściwości szyfrowania danych serwera.

properties.fullyQualifiedDomainName

string

W pełni kwalifikowana nazwa domeny serwera.

properties.highAvailability

HighAvailability

Właściwości wysokiej dostępności serwera.

properties.maintenanceWindow

MaintenanceWindow

Właściwości okna obsługi serwera.

properties.minorVersion

string

Wersja pomocnicza serwera.

properties.network

Network

Właściwości sieci serwera. Ta właściwość sieci jest wymagana do przekazania tylko w przypadku, gdy serwer ma być serwerem dostępu prywatnego.

properties.pointInTimeUTC

string

Czas tworzenia punktu przywracania (format ISO8601), określając czas przywracania z. Jest to wymagane, gdy wartość "createMode" to "PointInTimeRestore" lub "GeoRestore".

properties.replicaCapacity

integer

Repliki dozwolone dla serwera.

properties.replicationRole

ReplicationRole

Rola replikacji serwera

properties.sourceServerResourceId

string

Identyfikator zasobu serwera źródłowego do przywrócenia. Jest to wymagane, gdy element "createMode" to "PointInTimeRestore" lub "GeoRestore" lub "Replica". Ta właściwość jest zwracana tylko dla serwera repliki

properties.state

ServerState

Stan serwera, który jest widoczny dla użytkownika.

properties.storage

Storage

Właściwości magazynu serwera.

properties.version

ServerVersion

Wersja serwera PostgreSQL.

sku

Sku

Jednostka SKU (warstwa cenowa) serwera.

systemData

systemData

Metadane systemowe odnoszące się do tego zasobu.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ServerHAState

Stan serwera wysokiej dostępności, który jest widoczny dla użytkownika.

Nazwa Typ Opis
CreatingStandby

string

FailingOver

string

Healthy

string

NotEnabled

string

RemovingStandby

string

ReplicatingData

string

ServerPublicNetworkAccessState

dostęp do sieci publicznej jest włączony lub nie

Nazwa Typ Opis
Disabled

string

Enabled

string

ServerState

Stan serwera, który jest widoczny dla użytkownika.

Nazwa Typ Opis
Disabled

string

Dropping

string

Ready

string

Starting

string

Stopped

string

Stopping

string

Updating

string

ServerVersion

Wersja serwera PostgreSQL.

Nazwa Typ Opis
11

string

12

string

13

string

14

string

Sku

Jednostka SKU (warstwa cenowa) serwera.

Nazwa Typ Opis
name

string

Nazwa jednostki SKU, zwykle, warstwa + rodzina i rdzenie, np. Standard_D4s_v3.

tier

SkuTier

Warstwa konkretnej jednostki SKU, np. z możliwością rozszerzenia.

SkuTier

Warstwa konkretnej jednostki SKU, np. z możliwością rozszerzenia.

Nazwa Typ Opis
Burstable

string

GeneralPurpose

string

MemoryOptimized

string

Storage

Właściwości magazynu serwera.

Nazwa Typ Opis
storageSizeGB

integer

Maksymalny dozwolony magazyn dla serwera.

systemData

Metadane systemowe odnoszące się do tego zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentity

Opisuje tożsamość aplikacji.

Nazwa Typ Opis
tenantId

string

Identyfikator dzierżawy serwera.

type

IdentityType

typy tożsamości skojarzonych z tym zasobem; obecnie ograniczone do parametru "None and UserAssigned"

userAssignedIdentities

<string,  UserIdentity>

reprezentuje mapę tożsamości przypisanych przez użytkownika.

UserIdentity

Opisuje tożsamość przypisaną przez jednego użytkownika skojarzona z aplikacją.

Nazwa Typ Opis
clientId

string

identyfikator klienta jednostki usługi, którą reprezentuje ta tożsamość.

principalId

string

identyfikator obiektu jednostki usługi, którą reprezentuje ta tożsamość.