Replicas - List By Server
Listet alle Replikate für einen bestimmten Server auf.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas?api-version=2022-12-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
server
|
path | True |
string |
Name des Servers RegEx-Muster: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ReplicasListByServer
Beispielanforderung
GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername/replicas?api-version=2022-12-01
Beispiel für eine Antwort
{
"value": [
{
"sku": {
"name": "Standard_D4s_v3",
"tier": "GeneralPurpose"
},
"properties": {
"fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com",
"version": "12",
"minorVersion": "6",
"administratorLogin": "cloudsa",
"state": "Ready",
"availabilityZone": "2",
"storage": {
"storageSizeGB": 512
},
"dataEncryption": {
"type": "SystemManaged"
},
"authConfig": {
"activeDirectoryAuth": "Disabled",
"passwordAuth": "Enabled"
},
"backup": {
"backupRetentionDays": 7,
"geoRedundantBackup": "Disabled",
"earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00"
},
"network": {
"publicNetworkAccess": "Enabled"
},
"highAvailability": {
"mode": "Disabled",
"state": "NotEnabled"
},
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"replicationRole": "AsyncReplica",
"replicaCapacity": 0
},
"location": "westus",
"tags": {
"ElasticServer": "1"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep",
"name": "pgtestsvc5rep",
"type": "Microsoft.DBforPostgreSQL/flexibleServers"
}
]
}
Definitionen
Name | Beschreibung |
---|---|
active |
Wenn aktiviert ist, ist die Azure Active Directory-Authentifizierung aktiviert. |
Arm |
Datenverschlüsselungstyp, der darstellen soll, ob es sich um systemverwaltete und Azure Key Vault handelt. |
Auth |
Eigenschaften der Authentifizierungskonfiguration eines Servers |
Backup |
Sicherungseigenschaften eines Servers |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Create |
Der Modus zum Erstellen eines neuen PostgreSQL-Servers. |
Data |
Datenverschlüsselungseigenschaften eines Servers |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Geo |
Ein Wert, der angibt, ob Geo-Redundant Sicherung auf dem Server aktiviert ist. |
High |
Hochverfügbarkeitseigenschaften eines Servers |
High |
Der Hochverfügbarkeitsmodus für den Server. |
Identity |
die Identitätstypen, die dieser Ressource zugeordnet sind; derzeit auf "None" und "UserAssigned" beschränkt |
Maintenance |
Wartungsfenstereigenschaften eines Servers. |
Network |
Netzwerkeigenschaften eines Servers. |
password |
Wenn aktiviert, ist die Kennwortauthentifizierung aktiviert. |
Replication |
Wird verwendet, um die Rolle des Servers in der Replikationsgruppe anzugeben. |
Server |
Stellt einen Server dar. |
Server |
Ein Zustand eines Hochverfügbarkeitsservers, der für den Benutzer sichtbar ist. |
Server |
Eine Liste von Servern. |
Server |
Der Zugriff auf öffentliche Netzwerke ist aktiviert oder nicht |
Server |
Ein Zustand eines Servers, der für den Benutzer sichtbar ist. |
Server |
Die Version eines Servers. |
Sku |
SKU-Informationen bezogene Eigenschaften eines Servers. |
Sku |
Die Ebene der jeweiligen SKU, z. B. Burstable. |
Storage |
Speichereigenschaften eines Servers |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
User |
Informationen zur Beschreibung der Identitäten, die dieser Anwendung zugeordnet sind. |
User |
Beschreibt eine einzelne benutzerseitig zugewiesene Identität, die der Anwendung zugeordnet ist. |
activeDirectoryAuthEnum
Wenn aktiviert ist, ist die Azure Active Directory-Authentifizierung aktiviert.
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ArmServerKeyType
Datenverschlüsselungstyp, der darstellen soll, ob es sich um systemverwaltete und Azure Key Vault handelt.
Name | Typ | Beschreibung |
---|---|---|
AzureKeyVault |
string |
|
SystemManaged |
string |
AuthConfig
Eigenschaften der Authentifizierungskonfiguration eines Servers
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
activeDirectoryAuth |
Wenn aktiviert, ist die Azure Active Directory-Authentifizierung aktiviert. |
||
passwordAuth | Enabled |
Wenn aktiviert, ist die Kennwortauthentifizierung aktiviert. |
|
tenantId |
string |
Mandanten-ID des Servers. |
Backup
Sicherungseigenschaften eines Servers
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
backupRetentionDays |
integer |
7 |
Sicherungsaufbewahrungstage für den Server. |
earliestRestoreDate |
string |
Die früheste Wiederherstellungspunktzeit (ISO8601 Format) für den Server. |
|
geoRedundantBackup | Disabled |
Ein Wert, der angibt, ob Geo-Redundant Sicherung auf dem Server aktiviert ist. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
Der Modus zum Erstellen eines neuen PostgreSQL-Servers.
Name | Typ | Beschreibung |
---|---|---|
Create |
string |
|
Default |
string |
|
GeoRestore |
string |
|
PointInTimeRestore |
string |
|
Replica |
string |
|
Update |
string |
DataEncryption
Datenverschlüsselungseigenschaften eines Servers
Name | Typ | Beschreibung |
---|---|---|
primaryKeyURI |
string |
URI für den Schlüssel für die Datenverschlüsselung für den primären Server. |
primaryUserAssignedIdentityId |
string |
Ressourcen-ID für die vom Benutzer zugewiesene Identität, die für die Datenverschlüsselung für den primären Server verwendet werden soll. |
type |
Datenverschlüsselungstyp, der angibt, ob es sich um "Systemverwaltete" im Vergleich zu Azure Key Vault handelt. |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
GeoRedundantBackupEnum
Ein Wert, der angibt, ob Geo-Redundant Sicherung auf dem Server aktiviert ist.
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
|
Enabled |
string |
HighAvailability
Hochverfügbarkeitseigenschaften eines Servers
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
mode | Disabled |
Der Hochverfügbarkeitsmodus für den Server. |
|
standbyAvailabilityZone |
string |
Verfügbarkeitszoneninformationen des Standbymodus. |
|
state |
Ein Zustand eines Hochverfügbarkeitsservers, der für den Benutzer sichtbar ist. |
HighAvailabilityMode
Der Hochverfügbarkeitsmodus für den Server.
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
|
SameZone |
string |
|
ZoneRedundant |
string |
IdentityType
die Identitätstypen, die dieser Ressource zugeordnet sind; derzeit auf "None" und "UserAssigned" beschränkt
Name | Typ | Beschreibung |
---|---|---|
None |
string |
|
UserAssigned |
string |
MaintenanceWindow
Wartungsfenstereigenschaften eines Servers.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
customWindow |
string |
Disabled |
gibt an, ob das benutzerdefinierte Fenster aktiviert oder deaktiviert ist. |
dayOfWeek |
integer |
0 |
Wochentag für Wartungsfenster |
startHour |
integer |
0 |
Startstunde für Wartungsfenster |
startMinute |
integer |
0 |
Startminute für Wartungsfenster |
Network
Netzwerkeigenschaften eines Servers.
Name | Typ | Beschreibung |
---|---|---|
delegatedSubnetResourceId |
string |
Ressourcen-ID des delegierten Subnetzes. Dies muss während der Erstellung übergeben werden, falls der Server in das VNET eingefügt werden soll, d. h. ein Privater Zugriffsserver. Übergeben Sie dies während des Updates nur, wenn der Wert für Privates DNS Zone aktualisiert werden soll. |
privateDnsZoneArmResourceId |
string |
Arm-Ressourcen-ID der privaten DNS-Zone. Dies muss während der Erstellung übergeben werden, falls der Server in das VNET eingefügt werden soll, d. h. ein Privater Zugriffsserver. Übergeben Sie dies während des Updates nur, wenn der Wert für Privates DNS Zone aktualisiert werden soll. |
publicNetworkAccess |
Zugriff auf öffentliche Netzwerke ist aktiviert oder nicht |
passwordAuthEnum
Wenn aktiviert, ist die Kennwortauthentifizierung aktiviert.
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ReplicationRole
Wird verwendet, um die Rolle des Servers in der Replikationsgruppe anzugeben.
Name | Typ | Beschreibung |
---|---|---|
AsyncReplica |
string |
|
GeoAsyncReplica |
string |
|
None |
string |
|
Primary |
string |
Server
Stellt einen Server dar.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Beschreibt die Identität der Anwendung. |
|
location |
string |
Der geografische Standort, an dem sich die Ressource befindet |
name |
string |
Der Name der Ressource |
properties.administratorLogin |
string |
Der Anmeldename des Administrators eines Servers. Kann nur angegeben werden, wenn der Server erstellt wird (und für die Erstellung erforderlich ist). |
properties.administratorLoginPassword |
string |
Das Administratoranmeldekennwort (erforderlich für die Servererstellung). |
properties.authConfig |
AuthConfig-Eigenschaften eines Servers. |
|
properties.availabilityZone |
string |
Verfügbarkeitszoneninformationen des Servers. |
properties.backup |
Sicherungseigenschaften eines Servers. |
|
properties.createMode |
Der Modus zum Erstellen eines neuen PostgreSQL-Servers. |
|
properties.dataEncryption |
Datenverschlüsselungseigenschaften eines Servers. |
|
properties.fullyQualifiedDomainName |
string |
Der vollqualifizierte Domänenname eines Servers. |
properties.highAvailability |
Hochverfügbarkeitseigenschaften eines Servers. |
|
properties.maintenanceWindow |
Wartungsfenstereigenschaften eines Servers. |
|
properties.minorVersion |
string |
Die Nebenversion des Servers. |
properties.network |
Netzwerkeigenschaften eines Servers. Diese Network-Eigenschaft muss nur für den Fall übergeben werden, dass es sich bei dem Server um einen Server mit privatem Zugriff handelt. |
|
properties.pointInTimeUTC |
string |
Erstellungszeit des Wiederherstellungspunkts (ISO8601 Format), in dem die Wiederherstellungszeit angegeben wird. Dies ist erforderlich, wenn "createMode" auf "PointInTimeRestore" oder "GeoRestore" festgelegt ist. |
properties.replicaCapacity |
integer |
Für einen Server zulässige Replikate. |
properties.replicationRole |
Replikationsrolle des Servers |
|
properties.sourceServerResourceId |
string |
Die Ressourcen-ID des Quellservers, aus der die Wiederherstellung ausgeführt werden soll. Dies ist erforderlich, wenn "createMode" auf "PointInTimeRestore" oder "GeoRestore" oder "Replica" festgelegt ist. Diese Eigenschaft wird nur für den Replikatserver zurückgegeben. |
properties.state |
Ein Zustand eines Servers, der für den Benutzer sichtbar ist. |
|
properties.storage |
Speichereigenschaften eines Servers. |
|
properties.version |
PostgreSQL Server-Version. |
|
sku |
Die SKU (Tarif) des Servers. |
|
systemData |
Die Systemmetadaten, die sich auf diese Ressource beziehen. |
|
tags |
object |
Ressourcentags. |
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
ServerHAState
Ein Zustand eines Hochverfügbarkeitsservers, der für den Benutzer sichtbar ist.
Name | Typ | Beschreibung |
---|---|---|
CreatingStandby |
string |
|
FailingOver |
string |
|
Healthy |
string |
|
NotEnabled |
string |
|
RemovingStandby |
string |
|
ReplicatingData |
string |
ServerListResult
Eine Liste von Servern.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Der Link, der verwendet wird, um die nächste Seite von Vorgängen abzurufen. |
value |
Server[] |
Die Liste der flexiblen Server |
ServerPublicNetworkAccessState
Der Zugriff auf öffentliche Netzwerke ist aktiviert oder nicht
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ServerState
Ein Zustand eines Servers, der für den Benutzer sichtbar ist.
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
|
Dropping |
string |
|
Ready |
string |
|
Starting |
string |
|
Stopped |
string |
|
Stopping |
string |
|
Updating |
string |
ServerVersion
Die Version eines Servers.
Name | Typ | Beschreibung |
---|---|---|
11 |
string |
|
12 |
string |
|
13 |
string |
|
14 |
string |
Sku
SKU-Informationen bezogene Eigenschaften eines Servers.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name der SKU, in der Regel Ebene + Familie + Kerne, z. B. Standard_D4s_v3. |
tier |
Die Ebene der jeweiligen SKU, z. B. Burstable. |
SkuTier
Die Ebene der jeweiligen SKU, z. B. Burstable.
Name | Typ | Beschreibung |
---|---|---|
Burstable |
string |
|
GeneralPurpose |
string |
|
MemoryOptimized |
string |
Storage
Speichereigenschaften eines Servers
Name | Typ | Beschreibung |
---|---|---|
storageSizeGB |
integer |
Maximal zulässiger Speicher für einen Server. |
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
UserAssignedIdentity
Informationen zur Beschreibung der Identitäten, die dieser Anwendung zugeordnet sind.
Name | Typ | Beschreibung |
---|---|---|
tenantId |
string |
Mandanten-ID des Servers. |
type |
die Identitätstypen, die dieser Ressource zugeordnet sind; derzeit auf "None" und "UserAssigned" beschränkt |
|
userAssignedIdentities |
<string,
User |
stellt benutzerseitig zugewiesene Identitäten dar. |
UserIdentity
Beschreibt eine einzelne benutzerseitig zugewiesene Identität, die der Anwendung zugeordnet ist.
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
der Clientbezeichner des Dienstprinzipals, den diese Identität darstellt. |
principalId |
string |
Der Objektbezeichner des Dienstprinzipals, den diese Identität darstellt. |