Dela via


Replicas - List By Server

Visa en lista över alla repliker för en viss server.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serverName
path True

string

Namnet på servern.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

subscriptionId
path True

string

uuid

ID för målprenumerationen. Värdet måste vara ett UUID.

api-version
query True

string

DEN API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

ServerListResult

OKEJ

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ReplicasListByServer

Exempelbegäran

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername/replicas?api-version=2024-11-01-preview

Exempelsvar

{
  "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,
          "autoGrow": "Disabled",
          "tier": "P20",
          "iops": 2300
        },
        "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,
        "replica": {
          "role": "AsyncReplica",
          "capacity": 0,
          "replicationState": "Active"
        }
      },
      "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"
    }
  ]
}

Definitioner

Name Description
activeDirectoryAuthEnum

Om aktiverad är Azure Active Directory-autentisering aktiverat.

ArmServerKeyType

Datakrypteringstyp som ska visas om den är Systemhanterad jämfört med Azure Key Vault.

AuthConfig

Autentiseringskonfigurationsegenskaper för en server

AzureManagedDiskPerformanceTiers

Namn på lagringsnivå för IOPS.

Backup

Säkerhetskopieringsegenskaper för en server

Cluster

Klusteregenskaper för en server.

createdByType

Den typ av identitet som skapade resursen.

CreateMode

Läget för att skapa en ny PostgreSQL-server.

DataEncryption

Datakrypteringsegenskaper för en server

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

GeoRedundantBackupEnum

Ett värde som anger om Geo-Redundant säkerhetskopiering är aktiverad på servern.

HighAvailability

Egenskaper för hög tillgänglighet för en server

HighAvailabilityMode

HA-läget för servern.

IdentityType

de typer av identiteter som är associerade med den här resursen

keyStatusEnum

Primär krypteringsnyckelstatus för datakrypteringsaktiverad server.

MaintenanceWindow

Egenskaper för underhållsfönster för en server.

Network

Nätverksegenskaper för en server.

passwordAuthEnum

Om aktiverad är lösenordsautentisering aktiverat.

PrivateEndpoint

Den privata slutpunktsresursen.

PrivateEndpointConnection

Den privata slutpunktsanslutningsresursen.

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

ReadReplicaPromoteMode

Anger upphöjningsläget för en replikserver. Det här är en skrivskyddad egenskap.

Replica

Replikegenskaper för en server

ReplicationPromoteOption

Anger alternativ för att höja upp för en replikserver. Det här är en skrivskyddad egenskap.

ReplicationRole

Används för att ange serverns roll i replikeringsuppsättningen.

ReplicationState

Hämtar replikeringstillståndet för en replikserver. Den här egenskapen returneras endast för api-anrop för repliker. Värden som stöds är Active, Catchup, Provisioning, Updating, Broken, Reconfiguring

Server

Representerar en server.

ServerHAState

Ett tillstånd för en HA-server som är synlig för användaren.

ServerListResult

En lista över servrar.

ServerPublicNetworkAccessState

offentlig nätverksåtkomst är aktiverad eller inte

ServerState

Ett tillstånd för en server som är synlig för användaren.

ServerVersion

Versionen av en server.

Sku

SKU-informationsrelaterade egenskaper för en server.

SkuTier

Nivån för den specifika SKU:n, t.ex. Burstable.

Storage

Lagringsegenskaper för en server

StorageAutoGrow

Flagga för att aktivera/inaktivera Automatisk ökning av lagring för flexibel server.

StorageType

Lagringstyp för servern. Tillåtna värden är Premium_LRS, PremiumV2_LRS och UltraSSD_LRS. Standardvärdet är Premium_LRS om det inte anges

systemData

Metadata som rör skapande och senaste ändring av resursen.

UserAssignedIdentity

Information som beskriver de identiteter som är associerade med det här programmet.

UserIdentity

Beskriver en enskild användartilldelad identitet som är associerad med programmet.

activeDirectoryAuthEnum

Om aktiverad är Azure Active Directory-autentisering aktiverat.

Värde Description
Disabled
Enabled

ArmServerKeyType

Datakrypteringstyp som ska visas om den är Systemhanterad jämfört med Azure Key Vault.

Värde Description
AzureKeyVault
SystemManaged

AuthConfig

Autentiseringskonfigurationsegenskaper för en server

Name Typ Standardvärde Description
activeDirectoryAuth

activeDirectoryAuthEnum

Om aktiverad är Azure Active Directory-autentisering aktiverat.

passwordAuth

passwordAuthEnum

Enabled

Om aktiverad är lösenordsautentisering aktiverat.

tenantId

string

Klient-ID för servern.

AzureManagedDiskPerformanceTiers

Namn på lagringsnivå för IOPS.

Värde Description
P1
P10
P15
P2
P20
P3
P30
P4
P40
P50
P6
P60
P70
P80

Backup

Säkerhetskopieringsegenskaper för en server

Name Typ Standardvärde Description
backupRetentionDays

integer

7

Kvarhållningsdagar för säkerhetskopiering för servern.

earliestRestoreDate

string

Den tidigaste återställningspunkten (ISO8601 format) för servern.

geoRedundantBackup

GeoRedundantBackupEnum

Disabled

Ett värde som anger om Geo-Redundant säkerhetskopiering är aktiverad på servern.

Cluster

Klusteregenskaper för en server.

Name Typ Standardvärde Description
clusterSize

integer

0

Antalet noder för klustret.

createdByType

Den typ av identitet som skapade resursen.

Värde Description
Application
Key
ManagedIdentity
User

CreateMode

Läget för att skapa en ny PostgreSQL-server.

Värde Description
Create
Default
GeoRestore
PointInTimeRestore
Replica
ReviveDropped
Update

DataEncryption

Datakrypteringsegenskaper för en server

Name Typ Description
geoBackupEncryptionKeyStatus

keyStatusEnum

Krypteringsnyckelstatus för geo-säkerhetskopiering för datakrypteringsaktiverad server.

geoBackupKeyURI

string

URI för nyckeln i keyvault för datakryptering för geo-säkerhetskopiering av servern.

geoBackupUserAssignedIdentityId

string

Resurs-ID för den användartilldelade identitet som ska användas för datakryptering för geo-säkerhetskopiering av servern.

primaryEncryptionKeyStatus

keyStatusEnum

Primär krypteringsnyckelstatus för datakrypteringsaktiverad server.

primaryKeyURI

string

URI för nyckeln i keyvault för datakryptering av den primära servern.

primaryUserAssignedIdentityId

string

Resurs-ID för den användartilldelade identitet som ska användas för datakryptering av den primära servern.

type

ArmServerKeyType

Datakrypteringstyp som ska visas om den är Systemhanterad jämfört med Azure Key Vault.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

GeoRedundantBackupEnum

Ett värde som anger om Geo-Redundant säkerhetskopiering är aktiverad på servern.

Värde Description
Disabled
Enabled

HighAvailability

Egenskaper för hög tillgänglighet för en server

Name Typ Standardvärde Description
mode

HighAvailabilityMode

Disabled

HA-läget för servern.

standbyAvailabilityZone

string

tillgänglighetszoninformation för vänteläge.

state

ServerHAState

Ett tillstånd för en HA-server som är synlig för användaren.

HighAvailabilityMode

HA-läget för servern.

Värde Description
Disabled
SameZone
ZoneRedundant

IdentityType

de typer av identiteter som är associerade med den här resursen

Värde Description
None
SystemAssigned
UserAssigned

keyStatusEnum

Primär krypteringsnyckelstatus för datakrypteringsaktiverad server.

Värde Description
Invalid
Valid

MaintenanceWindow

Egenskaper för underhållsfönster för en server.

Name Typ Standardvärde Description
customWindow

string

Disabled

anger om anpassat fönster är aktiverat eller inaktiverat

dayOfWeek

integer

0

dag i veckan för underhållsperiod

startHour

integer

0

starttimmes för underhållsperiod

startMinute

integer

0

startminut för underhållsperiod

Network

Nätverksegenskaper för en server.

Name Typ Description
delegatedSubnetResourceId

string

Resurs-ID för delegerade undernätsarmen. Detta måste skickas under skapande, om vi vill att servern ska matas in med VNET, dvs. privat åtkomstserver. Under uppdateringen skickar du endast detta om vi vill uppdatera värdet för privat DNS-zon.

privateDnsZoneArmResourceId

string

Resurs-ID för privat dns-zon. Detta måste skickas under skapande, om vi vill att servern ska matas in med VNET, dvs. privat åtkomstserver. Under uppdateringen skickar du endast detta om vi vill uppdatera värdet för privat DNS-zon.

publicNetworkAccess

ServerPublicNetworkAccessState

offentlig nätverksåtkomst är aktiverad eller inte

passwordAuthEnum

Om aktiverad är lösenordsautentisering aktiverat.

Värde Description
Disabled
Enabled

PrivateEndpoint

Den privata slutpunktsresursen.

Name Typ Description
id

string

ARM-identifieraren för privat slutpunkt.

PrivateEndpointConnection

Den privata slutpunktsanslutningsresursen.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Namnet på resursen

properties.groupIds

string[]

Grupp-ID:t för den privata slutpunktsresursen.

properties.privateEndpoint

PrivateEndpoint

Den privata slutpunktsresursen.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Etableringstillståndet för den privata slutpunktsanslutningsresursen.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

Värde Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Värde Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Name Typ Description
actionsRequired

string

Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.

description

string

Orsak till godkännande/avvisande av anslutningen.

status

PrivateEndpointServiceConnectionStatus

Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

ReadReplicaPromoteMode

Anger upphöjningsläget för en replikserver. Det här är en skrivskyddad egenskap.

Värde Description
standalone
switchover

Replica

Replikegenskaper för en server

Name Typ Description
capacity

integer

Repliker tillåts för en server.

promoteMode

ReadReplicaPromoteMode

Anger upphöjningsläget för en replikserver. Det här är en skrivskyddad egenskap.

promoteOption

ReplicationPromoteOption

Anger alternativ för att höja upp för en replikserver. Det här är en skrivskyddad egenskap.

replicationState

ReplicationState

Hämtar replikeringstillståndet för en replikserver. Den här egenskapen returneras endast för api-anrop för repliker. Värden som stöds är Active, Catchup, Provisioning, Updating, Broken, Reconfiguring

role

ReplicationRole

Används för att ange serverns roll i replikeringsuppsättningen.

ReplicationPromoteOption

Anger alternativ för att höja upp för en replikserver. Det här är en skrivskyddad egenskap.

Värde Description
forced
planned

ReplicationRole

Används för att ange serverns roll i replikeringsuppsättningen.

Värde Description
AsyncReplica
GeoAsyncReplica
None
Primary

ReplicationState

Hämtar replikeringstillståndet för en replikserver. Den här egenskapen returneras endast för api-anrop för repliker. Värden som stöds är Active, Catchup, Provisioning, Updating, Broken, Reconfiguring

Värde Description
Active
Broken
Catchup
Provisioning
Reconfiguring
Updating

Server

Representerar en server.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

UserAssignedIdentity

Beskriver programmets identitet.

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.administratorLogin

string

Administratörens inloggningsnamn för en server. Kan bara anges när servern skapas (och krävs för att skapa).

properties.administratorLoginPassword

string

Administratörens inloggningslösenord (krävs för att skapa servern).

properties.authConfig

AuthConfig

AuthConfig-egenskaper för en server.

properties.availabilityZone

string

tillgänglighetszoninformation för servern.

properties.backup

Backup

Säkerhetskopieringsegenskaper för en server.

properties.cluster

Cluster

Klusteregenskaper för en server.

properties.createMode

CreateMode

Läget för att skapa en ny PostgreSQL-server.

properties.dataEncryption

DataEncryption

Datakrypteringsegenskaper för en server.

properties.fullyQualifiedDomainName

string

Det fullständigt kvalificerade domännamnet för en server.

properties.highAvailability

HighAvailability

Egenskaper för hög tillgänglighet för en server.

properties.maintenanceWindow

MaintenanceWindow

Egenskaper för underhållsfönster för en server.

properties.minorVersion

string

Delversionen av servern.

properties.network

Network

Nätverksegenskaper för en server. Den här nätverksegenskapen måste endast skickas om du vill att servern ska vara privat åtkomstserver.

properties.pointInTimeUTC

string

Skapandetid för återställningspunkt (ISO8601 format) som anger den tid som du ska återställa från. Det krävs när "createMode" är "PointInTimeRestore" eller "GeoRestore" eller "ReviveDropped".

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista över privata slutpunktsanslutningar som är associerade med den angivna resursen.

properties.replica

Replica

Replikegenskaper för en server. Dessa replikegenskaper måste endast skickas om du vill höja upp en server.

properties.replicaCapacity

integer

Repliker tillåts för en server.

properties.replicationRole

ReplicationRole

Replikeringsrollen för servern

properties.sourceServerResourceId

string

Källserverns resurs-ID som ska återställas från. Det krävs när "createMode" är "PointInTimeRestore" eller "GeoRestore" eller "Replica" eller "ReviveDropped". Den här egenskapen returneras endast för replikservern

properties.state

ServerState

Ett tillstånd för en server som är synlig för användaren.

properties.storage

Storage

Lagringsegenskaper för en server.

properties.version

ServerVersion

PostgreSQL Server-version.

sku

Sku

Serverns SKU (prisnivå).

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

tags

object

Resurstaggar.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ServerHAState

Ett tillstånd för en HA-server som är synlig för användaren.

Värde Description
CreatingStandby
FailingOver
Healthy
NotEnabled
RemovingStandby
ReplicatingData

ServerListResult

En lista över servrar.

Name Typ Description
nextLink

string

Länken som används för att hämta nästa sida med åtgärder.

value

Server[]

Listan över flexibla servrar

ServerPublicNetworkAccessState

offentlig nätverksåtkomst är aktiverad eller inte

Värde Description
Disabled
Enabled

ServerState

Ett tillstånd för en server som är synlig för användaren.

Värde Description
Disabled
Dropping
Ready
Starting
Stopped
Stopping
Updating

ServerVersion

Versionen av en server.

Värde Description
11
12
13
14
15
16
17

Sku

SKU-informationsrelaterade egenskaper för en server.

Name Typ Description
name

string

Namnet på sku:n, vanligtvis nivå + familj + kärnor, t.ex. Standard_D4s_v3.

tier

SkuTier

Nivån för den specifika SKU:n, t.ex. Burstable.

SkuTier

Nivån för den specifika SKU:n, t.ex. Burstable.

Värde Description
Burstable
GeneralPurpose
MemoryOptimized

Storage

Lagringsegenskaper för en server

Name Typ Description
autoGrow

StorageAutoGrow

Flagga för att aktivera/inaktivera Automatisk ökning av lagring för flexibel server.

iops

integer

IOPS-kvantitet på lagringsnivå. Den här egenskapen måste anges för lagringstyp PremiumV2_LRS och UltraSSD_LRS.

storageSizeGB

integer

Maximalt antal tillåtna lagringsutrymmen för en server.

throughput

integer

Lagringsdataflöde för servern. Detta måste anges för lagringstyp PremiumV2_LRS och UltraSSD_LRS.

tier

AzureManagedDiskPerformanceTiers

Namn på lagringsnivå för IOPS.

type

StorageType

Lagringstyp för servern. Tillåtna värden är Premium_LRS, PremiumV2_LRS och UltraSSD_LRS. Standardvärdet är Premium_LRS om det inte anges

StorageAutoGrow

Flagga för att aktivera/inaktivera Automatisk ökning av lagring för flexibel server.

Värde Description
Disabled
Enabled

StorageType

Lagringstyp för servern. Tillåtna värden är Premium_LRS, PremiumV2_LRS och UltraSSD_LRS. Standardvärdet är Premium_LRS om det inte anges

Värde Description
PremiumV2_LRS
Premium_LRS
UltraSSD_LRS

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Information som beskriver de identiteter som är associerade med det här programmet.

Name Typ Description
principalId

string

serverns identitetshuvudnamns-ID.

tenantId

string

Klient-ID för servern.

type

IdentityType

de typer av identiteter som är associerade med den här resursen

userAssignedIdentities

<string,  UserIdentity>

representerar mappning av användartilldelade identiteter.

UserIdentity

Beskriver en enskild användartilldelad identitet som är associerad med programmet.

Name Typ Description
clientId

string

klientidentifieraren för tjänstens huvudnamn som den här identiteten representerar.

principalId

string

objektidentifieraren för tjänstens huvudnamn som den här identiteten representerar.