Condividi tramite


Replicas - List By Server

Elencare tutte le repliche per un determinato server.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serverName
path True

string

Nome del server.

Criterio di espressione regolare: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

ServerListResult

OK

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ReplicasListByServer

Esempio di richiesta

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

Risposta di esempio

{
  "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"
    }
  ]
}

Definizioni

Nome Descrizione
activeDirectoryAuthEnum

Se Abilitato, l'autenticazione di Azure Active Directory è abilitata.

ArmServerKeyType

Tipo di crittografia dei dati da rappresentare se è gestito dal sistema rispetto ad Azure Key Vault.

AuthConfig

Proprietà di configurazione dell'autenticazione di un server

Backup

Proprietà di backup di un server

createdByType

Tipo di identità che ha creato la risorsa.

CreateMode

Modalità per creare un nuovo server PostgreSQL.

DataEncryption

Proprietà di crittografia dei dati di un server

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

GeoRedundantBackupEnum

Valore che indica se Geo-Redundant backup è abilitato nel server.

HighAvailability

Proprietà a disponibilità elevata di un server

HighAvailabilityMode

Modalità a disponibilità elevata per il server.

IdentityType

i tipi di identità associati a questa risorsa; attualmente limitato a 'Nessuno e UserAssigned'

MaintenanceWindow

Proprietà della finestra di manutenzione di un server.

Network

Proprietà di rete di un server.

passwordAuthEnum

Se Abilitato, l'autenticazione della password è abilitata.

ReplicationRole

Usato per indicare il ruolo del server nel set di replica.

Server

Rappresenta un server.

ServerHAState

Stato di un server a disponibilità elevata visibile all'utente.

ServerListResult

Elenco dei server.

ServerPublicNetworkAccessState

l'accesso alla rete pubblica è abilitato o meno

ServerState

Stato di un server visibile all'utente.

ServerVersion

Versione di un server.

Sku

Informazioni sullo sku relative alle proprietà di un server.

SkuTier

Livello dello SKU specifico, ad esempio Burstable.

Storage

Proprietà di archiviazione di un server

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

UserAssignedIdentity

Informazioni che descrivono le identità associate a questa applicazione.

UserIdentity

Descrive un'identità assegnata dall'utente singola associata all'applicazione.

activeDirectoryAuthEnum

Se Abilitato, l'autenticazione di Azure Active Directory è abilitata.

Nome Tipo Descrizione
Disabled

string

Enabled

string

ArmServerKeyType

Tipo di crittografia dei dati da rappresentare se è gestito dal sistema rispetto ad Azure Key Vault.

Nome Tipo Descrizione
AzureKeyVault

string

SystemManaged

string

AuthConfig

Proprietà di configurazione dell'autenticazione di un server

Nome Tipo Valore predefinito Descrizione
activeDirectoryAuth

activeDirectoryAuthEnum

Se abilitata, l'autenticazione di Azure Active Directory è abilitata.

passwordAuth

passwordAuthEnum

Enabled

Se abilitato, l'autenticazione password è abilitata.

tenantId

string

ID tenant del server.

Backup

Proprietà di backup di un server

Nome Tipo Valore predefinito Descrizione
backupRetentionDays

integer

7

Giorni di conservazione dei backup per il server.

earliestRestoreDate

string

Tempo di ripristino più recente (formato ISO8601) per il server.

geoRedundantBackup

GeoRedundantBackupEnum

Disabled

Valore che indica se Geo-Redundant backup è abilitato nel server.

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

CreateMode

Modalità per creare un nuovo server PostgreSQL.

Nome Tipo Descrizione
Create

string

Default

string

GeoRestore

string

PointInTimeRestore

string

Replica

string

Update

string

DataEncryption

Proprietà di crittografia dei dati di un server

Nome Tipo Descrizione
primaryKeyURI

string

URI per la chiave per la crittografia dei dati per il server primario.

primaryUserAssignedIdentityId

string

ID risorsa per l'identità assegnata dall'utente da usare per la crittografia dei dati per il server primario.

type

ArmServerKeyType

Tipo di crittografia dei dati da rappresentare se è Gestito dal sistema e dall'insieme di credenziali delle chiavi di Azure.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

GeoRedundantBackupEnum

Valore che indica se Geo-Redundant backup è abilitato nel server.

Nome Tipo Descrizione
Disabled

string

Enabled

string

HighAvailability

Proprietà a disponibilità elevata di un server

Nome Tipo Valore predefinito Descrizione
mode

HighAvailabilityMode

Disabled

Modalità a disponibilità elevata per il server.

standbyAvailabilityZone

string

informazioni sulla zona di disponibilità del standby.

state

ServerHAState

Stato di un server a disponibilità elevata visibile all'utente.

HighAvailabilityMode

Modalità a disponibilità elevata per il server.

Nome Tipo Descrizione
Disabled

string

SameZone

string

ZoneRedundant

string

IdentityType

i tipi di identità associati a questa risorsa; attualmente limitato a 'Nessuno e UserAssigned'

Nome Tipo Descrizione
None

string

UserAssigned

string

MaintenanceWindow

Proprietà della finestra di manutenzione di un server.

Nome Tipo Valore predefinito Descrizione
customWindow

string

Disabled

indica se la finestra personalizzata è abilitata o disabilitata

dayOfWeek

integer

0

giorno della settimana per la finestra di manutenzione

startHour

integer

0

ora di inizio per la finestra di manutenzione

startMinute

integer

0

inizio minuto per la finestra di manutenzione

Network

Proprietà di rete di un server.

Nome Tipo Descrizione
delegatedSubnetResourceId

string

ID risorsa resource resource arm di subnet delegata. Questa operazione deve essere passata durante la creazione, nel caso in cui il server venga inserito nella rete virtuale, ad esempio il server di accesso privato. Durante l'aggiornamento, passare questo solo se si vuole aggiornare il valore per DNS privato zona.

privateDnsZoneArmResourceId

string

ID risorsa risorsa del arm della zona dns privato. Questa operazione deve essere passata durante la creazione, nel caso in cui il server venga inserito nella rete virtuale, ad esempio il server di accesso privato. Durante l'aggiornamento, passare questo solo se si vuole aggiornare il valore per DNS privato zona.

publicNetworkAccess

ServerPublicNetworkAccessState

l'accesso alla rete pubblica è abilitato o meno

passwordAuthEnum

Se Abilitato, l'autenticazione della password è abilitata.

Nome Tipo Descrizione
Disabled

string

Enabled

string

ReplicationRole

Usato per indicare il ruolo del server nel set di replica.

Nome Tipo Descrizione
AsyncReplica

string

GeoAsyncReplica

string

None

string

Primary

string

Server

Rappresenta un server.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

UserAssignedIdentity

Descrive l'identità dell'applicazione.

location

string

Posizione geografica in cui vive la risorsa

name

string

nome della risorsa.

properties.administratorLogin

string

Nome di accesso dell'amministratore di un server. Può essere specificato solo quando il server viene creato (e è necessario per la creazione).

properties.administratorLoginPassword

string

Password di accesso amministratore (richiesta per la creazione del server).

properties.authConfig

AuthConfig

Proprietà AuthConfig di un server.

properties.availabilityZone

string

informazioni sulla zona di disponibilità del server.

properties.backup

Backup

Proprietà di backup di un server.

properties.createMode

CreateMode

Modalità per creare un nuovo server PostgreSQL.

properties.dataEncryption

DataEncryption

Proprietà di crittografia dei dati di un server.

properties.fullyQualifiedDomainName

string

Nome di dominio completo di un server.

properties.highAvailability

HighAvailability

Proprietà a disponibilità elevata di un server.

properties.maintenanceWindow

MaintenanceWindow

Proprietà della finestra di manutenzione di un server.

properties.minorVersion

string

Versione secondaria del server.

properties.network

Network

Proprietà di rete di un server. Questa proprietà Di rete deve essere passata solo nel caso in cui si desidera che il server sia server di accesso privato.

properties.pointInTimeUTC

string

Tempo di creazione del punto di ripristino (ISO8601 formato), specificando il tempo da cui eseguire il ripristino. È necessario quando "createMode" è "PointInTimeRestore" o "GeoRestore".

properties.replicaCapacity

integer

Repliche consentite per un server.

properties.replicationRole

ReplicationRole

Ruolo di replica del server

properties.sourceServerResourceId

string

ID risorsa del server di origine da cui eseguire il ripristino. È necessario quando 'createMode' è 'PointInTimeRestore' o 'GeoRestore' o 'Replica'. Questa proprietà viene restituita solo per il server di replica

properties.state

ServerState

Stato di un server visibile all'utente.

properties.storage

Storage

Proprietà di archiviazione di un server.

properties.version

ServerVersion

Versione di PostgreSQL Server.

sku

Sku

SKU (piano tariffario) del server.

systemData

systemData

Metadati di sistema relativi a questa risorsa.

tags

object

Tag di risorse.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ServerHAState

Stato di un server a disponibilità elevata visibile all'utente.

Nome Tipo Descrizione
CreatingStandby

string

FailingOver

string

Healthy

string

NotEnabled

string

RemovingStandby

string

ReplicatingData

string

ServerListResult

Elenco dei server.

Nome Tipo Descrizione
nextLink

string

Collegamento usato per ottenere la pagina successiva delle operazioni.

value

Server[]

Elenco di server flessibili

ServerPublicNetworkAccessState

l'accesso alla rete pubblica è abilitato o meno

Nome Tipo Descrizione
Disabled

string

Enabled

string

ServerState

Stato di un server visibile all'utente.

Nome Tipo Descrizione
Disabled

string

Dropping

string

Ready

string

Starting

string

Stopped

string

Stopping

string

Updating

string

ServerVersion

Versione di un server.

Nome Tipo Descrizione
11

string

12

string

13

string

14

string

Sku

Informazioni sullo sku relative alle proprietà di un server.

Nome Tipo Descrizione
name

string

Nome dello sku, in genere, livello + famiglia + core, ad esempio Standard_D4s_v3.

tier

SkuTier

Livello dello SKU specifico, ad esempio Burstable.

SkuTier

Livello dello SKU specifico, ad esempio Burstable.

Nome Tipo Descrizione
Burstable

string

GeneralPurpose

string

MemoryOptimized

string

Storage

Proprietà di archiviazione di un server

Nome Tipo Descrizione
storageSizeGB

integer

Spazio di archiviazione massimo consentito per un server.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima risorsa.

UserAssignedIdentity

Informazioni che descrivono le identità associate a questa applicazione.

Nome Tipo Descrizione
tenantId

string

ID tenant del server.

type

IdentityType

tipi di identità associate a questa risorsa; attualmente limitato a 'Nessuna e UserAssigned'

userAssignedIdentities

<string,  UserIdentity>

rappresenta la mappa delle identità assegnate dall'utente.

UserIdentity

Descrive un'identità assegnata dall'utente singola associata all'applicazione.

Nome Tipo Descrizione
clientId

string

identificatore client dell'entità servizio rappresentata da questa identità.

principalId

string

identificatore dell'oggetto dell'entità servizio che rappresenta questa identità.