Servers - Get
Získá informace o serveru.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}?api-version=2022-12-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
server
|
path | True |
string |
Název serveru. Vzor regulárního výrazu: |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
Server |
Server |
ServerGet
Ukázkový požadavek
GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1?api-version=2022-12-01
Ukázková odpověď
{
"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
Ukázkový požadavek
GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2022-12-01
Ukázková odpověď
{
"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"
}
Definice
Name | Description |
---|---|
active |
Pokud je povoleno, ověřování Azure Active Directory je povolené. |
Arm |
Typ šifrování dat, který znázorňuje, jestli se jedná o službu System Managed vs. Azure Key Vault. |
Auth |
Vlastnosti AuthConfig serveru. |
Backup |
Vlastnosti zálohování serveru. |
created |
Typ identity, která vytvořila prostředek. |
Create |
Režim vytvoření nového serveru PostgreSQL |
Data |
Vlastnosti šifrování dat serveru. |
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě. |
Error |
Odpověď na chybu |
Geo |
Hodnota označující, jestli je na serveru povolené zálohování Geo-Redundant. |
High |
Vlastnosti serveru s vysokou dostupností |
High |
Režim vysoké dostupnosti pro server. |
Identity |
typy identit přidružených k tomuto prostředku; v současné době je omezeno na žádné a přiřazené uživatele. |
Maintenance |
Vlastnosti časového období údržby serveru. |
Network |
Síťové vlastnosti serveru. Tato vlastnost Network musí být předána pouze v případě, že chcete, aby server byl serverem privátního přístupu. |
password |
Pokud je povoleno, ověřování heslem je povolené. |
Replication |
Role replikace serveru |
Server |
Představuje server. |
Server |
Stav serveru vysoké dostupnosti, který je viditelný pro uživatele. |
Server |
přístup z veřejné sítě je nebo není povolený |
Server |
Stav serveru, který je viditelný pro uživatele. |
Server |
Verze serveru PostgreSQL. |
Sku |
Skladová položka (cenová úroveň) serveru. |
Sku |
Úroveň konkrétní skladové položky, například Nárazová. |
Storage |
Vlastnosti úložiště serveru. |
system |
Systémová metadata týkající se tohoto prostředku. |
User |
Popisuje identitu aplikace. |
User |
Popisuje jednu identitu přiřazenou uživatelem přidruženou k aplikaci. |
activeDirectoryAuthEnum
Pokud je povoleno, ověřování Azure Active Directory je povolené.
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ArmServerKeyType
Typ šifrování dat, který znázorňuje, jestli se jedná o službu System Managed vs. Azure Key Vault.
Name | Typ | Description |
---|---|---|
AzureKeyVault |
string |
|
SystemManaged |
string |
AuthConfig
Vlastnosti AuthConfig serveru.
Name | Typ | Default value | Description |
---|---|---|---|
activeDirectoryAuth |
Pokud je povoleno, ověřování Azure Active Directory je povolené. |
||
passwordAuth | Enabled |
Pokud je povoleno, ověřování heslem je povolené. |
|
tenantId |
string |
ID tenanta serveru. |
Backup
Vlastnosti zálohování serveru.
Name | Typ | Default value | Description |
---|---|---|---|
backupRetentionDays |
integer |
7 |
Dny uchovávání záloh pro server. |
earliestRestoreDate |
string |
Nejstarší čas bodu obnovení (formát ISO8601) pro server. |
|
geoRedundantBackup | Disabled |
Hodnota označující, jestli je na serveru povolené zálohování Geo-Redundant. |
createdByType
Typ identity, která vytvořila prostředek.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
Režim vytvoření nového serveru PostgreSQL
Name | Typ | Description |
---|---|---|
Create |
string |
|
Default |
string |
|
GeoRestore |
string |
|
PointInTimeRestore |
string |
|
Replica |
string |
|
Update |
string |
DataEncryption
Vlastnosti šifrování dat serveru.
Name | Typ | Description |
---|---|---|
primaryKeyURI |
string |
Identifikátor URI pro klíč pro šifrování dat pro primární server. |
primaryUserAssignedIdentityId |
string |
ID prostředku pro identitu přiřazenou uživatelem, která se má použít k šifrování dat na primárním serveru. |
type |
Typ šifrování dat, který znázorňuje, jestli se jedná o službu System Managed vs. Azure Key Vault. |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Další typ informací. |
ErrorDetail
Podrobnosti o chybě.
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Odpověď na chybu
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
GeoRedundantBackupEnum
Hodnota označující, jestli je na serveru povolené zálohování Geo-Redundant.
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
HighAvailability
Vlastnosti serveru s vysokou dostupností
Name | Typ | Default value | Description |
---|---|---|---|
mode | Disabled |
Režim vysoké dostupnosti pro server. |
|
standbyAvailabilityZone |
string |
informace o zóně dostupnosti pohotovostního režimu. |
|
state |
Stav serveru vysoké dostupnosti, který je viditelný pro uživatele. |
HighAvailabilityMode
Režim vysoké dostupnosti pro server.
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
SameZone |
string |
|
ZoneRedundant |
string |
IdentityType
typy identit přidružených k tomuto prostředku; v současné době je omezeno na žádné a přiřazené uživatele.
Name | Typ | Description |
---|---|---|
None |
string |
|
UserAssigned |
string |
MaintenanceWindow
Vlastnosti časového období údržby serveru.
Name | Typ | Default value | Description |
---|---|---|---|
customWindow |
string |
Disabled |
určuje, jestli je vlastní okno povolené nebo zakázané. |
dayOfWeek |
integer |
0 |
den v týdnu pro časové období údržby |
startHour |
integer |
0 |
počáteční hodina časového období údržby |
startMinute |
integer |
0 |
počáteční minuta pro časové období údržby |
Network
Síťové vlastnosti serveru. Tato vlastnost Network musí být předána pouze v případě, že chcete, aby server byl serverem privátního přístupu.
Name | Typ | Description |
---|---|---|
delegatedSubnetResourceId |
string |
ID prostředku ARM delegovaného podsítě Toto je nutné předat během vytváření, pokud chceme, aby byl server vložen do virtuální sítě, tj. server soukromého přístupu. Během aktualizace tuto možnost předejte jenom v případě, že chceme aktualizovat hodnotu pro Privátní DNS zónu. |
privateDnsZoneArmResourceId |
string |
ID prostředku ARM zóny privátního DNS. Toto je nutné předat během vytváření, pokud chceme, aby byl server vložen do virtuální sítě, tj. server soukromého přístupu. Během aktualizace tuto možnost předejte jenom v případě, že chceme aktualizovat hodnotu pro Privátní DNS zónu. |
publicNetworkAccess |
přístup z veřejné sítě je nebo není povolený |
passwordAuthEnum
Pokud je povoleno, ověřování heslem je povolené.
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ReplicationRole
Role replikace serveru
Name | Typ | Description |
---|---|---|
AsyncReplica |
string |
|
GeoAsyncReplica |
string |
|
None |
string |
|
Primary |
string |
Server
Představuje server.
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Popisuje identitu aplikace. |
|
location |
string |
Geografické umístění, ve kterém se nachází prostředek |
name |
string |
Název prostředku |
properties.administratorLogin |
string |
Přihlašovací jméno správce serveru. Lze zadat pouze v případě, že se server vytváří (a vyžaduje se k vytvoření). |
properties.administratorLoginPassword |
string |
Přihlašovací heslo správce (vyžadované pro vytvoření serveru) |
properties.authConfig |
Vlastnosti AuthConfig serveru. |
|
properties.availabilityZone |
string |
informace o zóně dostupnosti serveru. |
properties.backup |
Vlastnosti zálohování serveru. |
|
properties.createMode |
Režim vytvoření nového serveru PostgreSQL |
|
properties.dataEncryption |
Vlastnosti šifrování dat serveru. |
|
properties.fullyQualifiedDomainName |
string |
Plně kvalifikovaný název domény serveru. |
properties.highAvailability |
Vlastnosti serveru s vysokou dostupností |
|
properties.maintenanceWindow |
Vlastnosti časového období údržby serveru. |
|
properties.minorVersion |
string |
Podverze serveru. |
properties.network |
Síťové vlastnosti serveru. Tato vlastnost Network musí být předána pouze v případě, že chcete, aby server byl serverem privátního přístupu. |
|
properties.pointInTimeUTC |
string |
Čas vytvoření bodu obnovení (ISO8601 formát) s určením času, ze který se má provést obnovení. Vyžaduje se, když createMode je PointInTimeRestore nebo GeoRestore. |
properties.replicaCapacity |
integer |
Povolené repliky pro server. |
properties.replicationRole |
Role replikace serveru |
|
properties.sourceServerResourceId |
string |
ID prostředku zdrojového serveru, ze které se má provést obnovení. Vyžaduje se, když createMode je PointInTimeRestore, GeoRestore nebo Replica. Tato vlastnost se vrátí jenom pro server repliky. |
properties.state |
Stav serveru, který je viditelný pro uživatele. |
|
properties.storage |
Vlastnosti úložiště serveru. |
|
properties.version |
Verze serveru PostgreSQL. |
|
sku |
Skladová položka (cenová úroveň) serveru. |
|
systemData |
Systémová metadata týkající se tohoto prostředku. |
|
tags |
object |
Značky prostředků. |
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
ServerHAState
Stav serveru vysoké dostupnosti, který je viditelný pro uživatele.
Name | Typ | Description |
---|---|---|
CreatingStandby |
string |
|
FailingOver |
string |
|
Healthy |
string |
|
NotEnabled |
string |
|
RemovingStandby |
string |
|
ReplicatingData |
string |
ServerPublicNetworkAccessState
přístup z veřejné sítě je nebo není povolený
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ServerState
Stav serveru, který je viditelný pro uživatele.
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Dropping |
string |
|
Ready |
string |
|
Starting |
string |
|
Stopped |
string |
|
Stopping |
string |
|
Updating |
string |
ServerVersion
Verze serveru PostgreSQL.
Name | Typ | Description |
---|---|---|
11 |
string |
|
12 |
string |
|
13 |
string |
|
14 |
string |
Sku
Skladová položka (cenová úroveň) serveru.
Name | Typ | Description |
---|---|---|
name |
string |
Název skladové položky, obvykle vrstva + rodina + jádra, například Standard_D4s_v3. |
tier |
Úroveň konkrétní skladové položky, například Nárazová. |
SkuTier
Úroveň konkrétní skladové položky, například Nárazová.
Name | Typ | Description |
---|---|---|
Burstable |
string |
|
GeneralPurpose |
string |
|
MemoryOptimized |
string |
Storage
Vlastnosti úložiště serveru.
Name | Typ | Description |
---|---|---|
storageSizeGB |
integer |
Maximální povolené úložiště pro server |
systemData
Systémová metadata týkající se tohoto prostředku.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Časové razítko vytvoření prostředku (UTC) |
createdBy |
string |
Identita, která prostředek vytvořila. |
createdByType |
Typ identity, která vytvořila prostředek. |
|
lastModifiedAt |
string |
Časové razítko poslední změny prostředku (UTC) |
lastModifiedBy |
string |
Identita, která naposledy změnila prostředek. |
lastModifiedByType |
Typ identity, která naposledy změnila prostředek. |
UserAssignedIdentity
Popisuje identitu aplikace.
Name | Typ | Description |
---|---|---|
tenantId |
string |
ID tenanta serveru. |
type |
typy identit přidružených k tomuto prostředku; v současné době je omezeno na žádné a přiřazené uživatele. |
|
userAssignedIdentities |
<string,
User |
představuje mapování identit přiřazených uživatelem. |
UserIdentity
Popisuje jednu identitu přiřazenou uživatelem přidruženou k aplikaci.
Name | Typ | Description |
---|---|---|
clientId |
string |
identifikátor klienta instančního objektu, který tato identita představuje. |
principalId |
string |
identifikátor objektu instančního objektu, který tato identita představuje. |