Partager via


Replicas - List By Server

Répertorie tous les réplicas d’un serveur donné.

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

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serverName
path True

string

Nom du serveur.

Modèle d’expression régulière: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

subscriptionId
path True

string

uuid

ID de l’abonnement cible. La valeur doit être un UUID.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

ServerListResult

D’ACCORD

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ReplicasListByServer

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
activeDirectoryAuthEnum

Si cette option est activée, l’authentification Azure Active Directory est activée.

ArmServerKeyType

Type de chiffrement de données à représenter s’il s’agit d’un coffre de clés Géré par le système et Azure Key Vault.

AuthConfig

Propriétés de configuration d’authentification d’un serveur

AzureManagedDiskPerformanceTiers

Nom du niveau de stockage pour les IOPS.

Backup

Propriétés de sauvegarde d’un serveur

Cluster

Propriétés du cluster d’un serveur.

createdByType

Type d’identité qui a créé la ressource.

CreateMode

Mode de création d’un serveur PostgreSQL.

DataEncryption

Propriétés de chiffrement des données d’un serveur

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

GeoRedundantBackupEnum

Valeur indiquant si Geo-Redundant sauvegarde est activée sur le serveur.

HighAvailability

Propriétés de haute disponibilité d’un serveur

HighAvailabilityMode

Mode haute disponibilité du serveur.

IdentityType

types d’identités associés à cette ressource

keyStatusEnum

État de clé de chiffrement primaire pour le serveur avec chiffrement des données.

MaintenanceWindow

Propriétés de la fenêtre de maintenance d’un serveur.

Network

Propriétés réseau d’un serveur.

passwordAuthEnum

Si cette option est activée, l’authentification par mot de passe est activée.

PrivateEndpoint

Ressource de point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

ReadReplicaPromoteMode

Définit le mode de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule.

Replica

Propriétés du réplica d’un serveur

ReplicationPromoteOption

Définit les options de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule.

ReplicationRole

Utilisé pour indiquer le rôle du serveur dans le jeu de réplication.

ReplicationState

Obtient l’état de réplication d’un serveur réplica. Cette propriété est retournée uniquement pour l’appel d’API réplicas. Les valeurs prises en charge sont Active, Catchup, Provisioning, Mise à jour, Broken, Reconfiguring

Server

Représente un serveur.

ServerHAState

État d’un serveur haute disponibilité visible par l’utilisateur.

ServerListResult

Liste des serveurs.

ServerPublicNetworkAccessState

l’accès au réseau public est activé ou non

ServerState

État d’un serveur visible par l’utilisateur.

ServerVersion

Version d’un serveur.

Sku

Propriétés associées aux informations de référence SKU d’un serveur.

SkuTier

Niveau de la référence SKU particulière, par exemple Burstable.

Storage

Propriétés de stockage d’un serveur

StorageAutoGrow

Indicateur permettant d’activer/désactiver la croissance automatique du stockage pour un serveur flexible.

StorageType

Type de stockage pour le serveur. Les valeurs autorisées sont Premium_LRS, PremiumV2_LRS et UltraSSD_LRS. La valeur par défaut est Premium_LRS si elle n’est pas spécifiée

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

UserAssignedIdentity

Informations décrivant les identités associées à cette application.

UserIdentity

Décrit une identité affectée par l’utilisateur unique associée à l’application.

activeDirectoryAuthEnum

Si cette option est activée, l’authentification Azure Active Directory est activée.

Valeur Description
Disabled
Enabled

ArmServerKeyType

Type de chiffrement de données à représenter s’il s’agit d’un coffre de clés Géré par le système et Azure Key Vault.

Valeur Description
AzureKeyVault
SystemManaged

AuthConfig

Propriétés de configuration d’authentification d’un serveur

Nom Type Valeur par défaut Description
activeDirectoryAuth

activeDirectoryAuthEnum

Si cette option est activée, l’authentification Azure Active Directory est activée.

passwordAuth

passwordAuthEnum

Enabled

Si cette option est activée, l’authentification par mot de passe est activée.

tenantId

string

ID de locataire du serveur.

AzureManagedDiskPerformanceTiers

Nom du niveau de stockage pour les IOPS.

Valeur Description
P1
P10
P15
P2
P20
P3
P30
P4
P40
P50
P6
P60
P70
P80

Backup

Propriétés de sauvegarde d’un serveur

Nom Type Valeur par défaut Description
backupRetentionDays

integer

7

Jours de rétention de sauvegarde pour le serveur.

earliestRestoreDate

string

Heure de point de restauration la plus ancienne (format ISO8601) pour le serveur.

geoRedundantBackup

GeoRedundantBackupEnum

Disabled

Valeur indiquant si Geo-Redundant sauvegarde est activée sur le serveur.

Cluster

Propriétés du cluster d’un serveur.

Nom Type Valeur par défaut Description
clusterSize

integer

0

Nombre de nœuds pour le cluster.

createdByType

Type d’identité qui a créé la ressource.

Valeur Description
Application
Key
ManagedIdentity
User

CreateMode

Mode de création d’un serveur PostgreSQL.

Valeur Description
Create
Default
GeoRestore
PointInTimeRestore
Replica
ReviveDropped
Update

DataEncryption

Propriétés de chiffrement des données d’un serveur

Nom Type Description
geoBackupEncryptionKeyStatus

keyStatusEnum

État de la clé de chiffrement de géo-sauvegarde pour le serveur avec chiffrement des données.

geoBackupKeyURI

string

URI de la clé dans keyvault pour le chiffrement des données pour la géo-sauvegarde du serveur.

geoBackupUserAssignedIdentityId

string

ID de ressource de l’identité affectée par l’utilisateur à utiliser pour le chiffrement des données pour la géo-sauvegarde du serveur.

primaryEncryptionKeyStatus

keyStatusEnum

État de clé de chiffrement primaire pour le serveur avec chiffrement des données.

primaryKeyURI

string

URI de la clé dans keyvault pour le chiffrement des données du serveur principal.

primaryUserAssignedIdentityId

string

ID de ressource de l’identité affectée par l’utilisateur à utiliser pour le chiffrement des données du serveur principal.

type

ArmServerKeyType

Type de chiffrement de données à représenter s’il s’agit d’un coffre de clés Géré par le système et Azure Key Vault.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

GeoRedundantBackupEnum

Valeur indiquant si Geo-Redundant sauvegarde est activée sur le serveur.

Valeur Description
Disabled
Enabled

HighAvailability

Propriétés de haute disponibilité d’un serveur

Nom Type Valeur par défaut Description
mode

HighAvailabilityMode

Disabled

Mode haute disponibilité du serveur.

standbyAvailabilityZone

string

informations sur la zone de disponibilité du serveur de secours.

state

ServerHAState

État d’un serveur haute disponibilité visible par l’utilisateur.

HighAvailabilityMode

Mode haute disponibilité du serveur.

Valeur Description
Disabled
SameZone
ZoneRedundant

IdentityType

types d’identités associés à cette ressource

Valeur Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

keyStatusEnum

État de clé de chiffrement primaire pour le serveur avec chiffrement des données.

Valeur Description
Invalid
Valid

MaintenanceWindow

Propriétés de la fenêtre de maintenance d’un serveur.

Nom Type Valeur par défaut Description
customWindow

string

Disabled

indique si la fenêtre personnalisée est activée ou désactivée

dayOfWeek

integer

0

jour de semaine pour la fenêtre de maintenance

startHour

integer

0

heure de début de la fenêtre de maintenance

startMinute

integer

0

minute de démarrage de la fenêtre de maintenance

Network

Propriétés réseau d’un serveur.

Nom Type Description
delegatedSubnetResourceId

string

ID de ressource du sous-réseau délégué. Cette opération doit être transmise pendant la création, au cas où nous voulons que le serveur soit injecté au réseau virtuel, c’est-à-dire un serveur d’accès privé. Pendant la mise à jour, transmettez-la uniquement si nous voulons mettre à jour la valeur de la zone DNS privée.

privateDnsZoneArmResourceId

string

ID de ressource arm de zone DNS privée. Cette opération doit être transmise pendant la création, au cas où nous voulons que le serveur soit injecté au réseau virtuel, c’est-à-dire un serveur d’accès privé. Pendant la mise à jour, transmettez-la uniquement si nous voulons mettre à jour la valeur de la zone DNS privée.

publicNetworkAccess

ServerPublicNetworkAccessState

l’accès au réseau public est activé ou non

passwordAuthEnum

Si cette option est activée, l’authentification par mot de passe est activée.

Valeur Description
Disabled
Enabled

PrivateEndpoint

Ressource de point de terminaison privé.

Nom Type Description
id

string

Identificateur ARM pour le point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

name

string

Nom de la ressource

properties.groupIds

string[]

ID de groupe pour la ressource de point de terminaison privé.

properties.privateEndpoint

PrivateEndpoint

Ressource de point de terminaison privé.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

État d’approvisionnement de la ressource de connexion de point de terminaison privé.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

Valeur Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.

Valeur Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

Nom Type Description
actionsRequired

string

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

description

string

Raison de l’approbation/rejet de la connexion.

status

PrivateEndpointServiceConnectionStatus

Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

ReadReplicaPromoteMode

Définit le mode de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule.

Valeur Description
standalone
switchover

Replica

Propriétés du réplica d’un serveur

Nom Type Description
capacity

integer

Réplicas autorisés pour un serveur.

promoteMode

ReadReplicaPromoteMode

Définit le mode de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule.

promoteOption

ReplicationPromoteOption

Définit les options de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule.

replicationState

ReplicationState

Obtient l’état de réplication d’un serveur réplica. Cette propriété est retournée uniquement pour l’appel d’API réplicas. Les valeurs prises en charge sont Active, Catchup, Provisioning, Mise à jour, Broken, Reconfiguring

role

ReplicationRole

Utilisé pour indiquer le rôle du serveur dans le jeu de réplication.

ReplicationPromoteOption

Définit les options de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule.

Valeur Description
forced
planned

ReplicationRole

Utilisé pour indiquer le rôle du serveur dans le jeu de réplication.

Valeur Description
AsyncReplica
GeoAsyncReplica
None
Primary

ReplicationState

Obtient l’état de réplication d’un serveur réplica. Cette propriété est retournée uniquement pour l’appel d’API réplicas. Les valeurs prises en charge sont Active, Catchup, Provisioning, Mise à jour, Broken, Reconfiguring

Valeur Description
Active
Broken
Catchup
Provisioning
Reconfiguring
Updating

Server

Représente un serveur.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

identity

UserAssignedIdentity

Décrit l’identité de l’application.

location

string

Emplacement géographique où réside la ressource

name

string

Nom de la ressource

properties.administratorLogin

string

Nom de connexion de l’administrateur d’un serveur. Ne peut être spécifié que lorsque le serveur est en cours de création (et est requis pour la création).

properties.administratorLoginPassword

string

Mot de passe de connexion administrateur (requis pour la création du serveur).

properties.authConfig

AuthConfig

Propriétés AuthConfig d’un serveur.

properties.availabilityZone

string

informations sur la zone de disponibilité du serveur.

properties.backup

Backup

Propriétés de sauvegarde d’un serveur.

properties.cluster

Cluster

Propriétés du cluster d’un serveur.

properties.createMode

CreateMode

Mode de création d’un serveur PostgreSQL.

properties.dataEncryption

DataEncryption

Propriétés de chiffrement des données d’un serveur.

properties.fullyQualifiedDomainName

string

Nom de domaine complet d’un serveur.

properties.highAvailability

HighAvailability

Propriétés de haute disponibilité d’un serveur.

properties.maintenanceWindow

MaintenanceWindow

Propriétés de la fenêtre de maintenance d’un serveur.

properties.minorVersion

string

Version mineure du serveur.

properties.network

Network

Propriétés réseau d’un serveur. Cette propriété réseau doit être transmise uniquement si vous souhaitez que le serveur soit un serveur d’accès privé.

properties.pointInTimeUTC

string

Heure de création du point de restauration (format ISO8601), en spécifiant l’heure de restauration à partir de laquelle effectuer la restauration. Il est nécessaire lorsque « createMode » est « PointInTimeRestore » ou « GeoRestore » ou « ReviveDropped ».

properties.privateEndpointConnections

PrivateEndpointConnection[]

Liste des connexions de point de terminaison privé associées à la ressource spécifiée.

properties.replica

Replica

Propriétés du réplica d’un serveur. Ces propriétés de réplica doivent être transmises uniquement si vous souhaitez promouvoir un serveur.

properties.replicaCapacity

integer

Réplicas autorisés pour un serveur.

properties.replicationRole

ReplicationRole

Rôle de réplication du serveur

properties.sourceServerResourceId

string

ID de ressource du serveur source à partir duquel effectuer la restauration. Il est nécessaire lorsque « createMode » est « PointInTimeRestore » ou « GeoRestore » ou « Replica » ou « ReviveDropped ». Cette propriété est retournée uniquement pour le serveur réplica

properties.state

ServerState

État d’un serveur visible par l’utilisateur.

properties.storage

Storage

Propriétés de stockage d’un serveur.

properties.version

ServerVersion

Version du serveur PostgreSQL.

sku

Sku

Référence SKU (niveau tarifaire) du serveur.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

tags

object

Balises de ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ServerHAState

État d’un serveur haute disponibilité visible par l’utilisateur.

Valeur Description
CreatingStandby
FailingOver
Healthy
NotEnabled
RemovingStandby
ReplicatingData

ServerListResult

Liste des serveurs.

Nom Type Description
nextLink

string

Lien utilisé pour obtenir la page suivante des opérations.

value

Server[]

Liste des serveurs flexibles

ServerPublicNetworkAccessState

l’accès au réseau public est activé ou non

Valeur Description
Disabled
Enabled

ServerState

État d’un serveur visible par l’utilisateur.

Valeur Description
Disabled
Dropping
Ready
Starting
Stopped
Stopping
Updating

ServerVersion

Version d’un serveur.

Valeur Description
11
12
13
14
15
16
17

Sku

Propriétés associées aux informations de référence SKU d’un serveur.

Nom Type Description
name

string

Nom de la référence SKU, généralement, niveau + famille + cœurs, par exemple Standard_D4s_v3.

tier

SkuTier

Niveau de la référence SKU particulière, par exemple Burstable.

SkuTier

Niveau de la référence SKU particulière, par exemple Burstable.

Valeur Description
Burstable
GeneralPurpose
MemoryOptimized

Storage

Propriétés de stockage d’un serveur

Nom Type Description
autoGrow

StorageAutoGrow

Indicateur permettant d’activer/désactiver la croissance automatique du stockage pour un serveur flexible.

iops

integer

Quantité d’IOPS du niveau de stockage. Cette propriété doit être définie pour le type de stockage PremiumV2_LRS et UltraSSD_LRS.

storageSizeGB

integer

Stockage maximal autorisé pour un serveur.

throughput

integer

Débit de stockage pour le serveur. Cette opération doit être définie pour le type de stockage PremiumV2_LRS et les UltraSSD_LRS.

tier

AzureManagedDiskPerformanceTiers

Nom du niveau de stockage pour les IOPS.

type

StorageType

Type de stockage pour le serveur. Les valeurs autorisées sont Premium_LRS, PremiumV2_LRS et UltraSSD_LRS. La valeur par défaut est Premium_LRS si elle n’est pas spécifiée

StorageAutoGrow

Indicateur permettant d’activer/désactiver la croissance automatique du stockage pour un serveur flexible.

Valeur Description
Disabled
Enabled

StorageType

Type de stockage pour le serveur. Les valeurs autorisées sont Premium_LRS, PremiumV2_LRS et UltraSSD_LRS. La valeur par défaut est Premium_LRS si elle n’est pas spécifiée

Valeur Description
PremiumV2_LRS
Premium_LRS
UltraSSD_LRS

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

UserAssignedIdentity

Informations décrivant les identités associées à cette application.

Nom Type Description
principalId

string

ID du principal d’identité du serveur.

tenantId

string

ID de locataire du serveur.

type

IdentityType

types d’identités associés à cette ressource

userAssignedIdentities

<string,  UserIdentity>

représente la carte des identités affectées par l’utilisateur.

UserIdentity

Décrit une identité affectée par l’utilisateur unique associée à l’application.

Nom Type Description
clientId

string

identificateur client du principal de service que cette identité représente.

principalId

string

identificateur d’objet du principal de service que cette identité représente.