Replicas - List By Server

Service:

PostgreSQL

Version d'API:

2025-08-01

Répertorie toutes les répliques en lecture d’un serveur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ServerList	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

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

List all read replicas of a server.

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/replicas?api-version=2025-08-01

Java

/**
 * Samples for Replicas ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/
     * ReplicasListByServer.json
     */
    /**
     * Sample code: List all read replicas of a server.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void
        listAllReadReplicasOfAServer(com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.replicas().listByServer("exampleresourcegroup", "exampleserver", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python replicas_list_by_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.replicas.list_by_server(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ReplicasListByServer.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armpostgresqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e96c24570a484cff13d153fb472f812878866a39/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ReplicasListByServer.json
func ExampleReplicasClient_NewListByServerPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReplicasClient().NewListByServerPager("exampleresourcegroup", "exampleserver", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerList = armpostgresqlflexibleservers.ServerList{
		// 	Value: []*armpostgresqlflexibleservers.Server{
		// 		{
		// 			Name: to.Ptr("exampleserver"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/flexibleServers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver"),
		// 			Location: to.Ptr("eastus"),
		// 			Properties: &armpostgresqlflexibleservers.ServerProperties{
		// 				AdministratorLogin: to.Ptr("exampleadministratorlogin"),
		// 				AuthConfig: &armpostgresqlflexibleservers.AuthConfig{
		// 					ActiveDirectoryAuth: to.Ptr(armpostgresqlflexibleservers.MicrosoftEntraAuthDisabled),
		// 					PasswordAuth: to.Ptr(armpostgresqlflexibleservers.PasswordBasedAuthEnabled),
		// 				},
		// 				AvailabilityZone: to.Ptr("2"),
		// 				Backup: &armpostgresqlflexibleservers.Backup{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-06-01T18:35:22.123Z"); return t}()),
		// 					GeoRedundantBackup: to.Ptr(armpostgresqlflexibleservers.GeographicallyRedundantBackupDisabled),
		// 				},
		// 				DataEncryption: &armpostgresqlflexibleservers.DataEncryption{
		// 					Type: to.Ptr(armpostgresqlflexibleservers.DataEncryptionTypeSystemManaged),
		// 				},
		// 				FullyQualifiedDomainName: to.Ptr("exampleserver.postgres.database.azure.com"),
		// 				HighAvailability: &armpostgresqlflexibleservers.HighAvailability{
		// 					Mode: to.Ptr(armpostgresqlflexibleservers.HighAvailabilityMode("Disabled")),
		// 					State: to.Ptr(armpostgresqlflexibleservers.HighAvailabilityStateNotEnabled),
		// 				},
		// 				MaintenanceWindow: &armpostgresqlflexibleservers.MaintenanceWindow{
		// 					CustomWindow: to.Ptr("Disabled"),
		// 					DayOfWeek: to.Ptr[int32](0),
		// 					StartHour: to.Ptr[int32](0),
		// 					StartMinute: to.Ptr[int32](0),
		// 				},
		// 				MinorVersion: to.Ptr("5"),
		// 				Network: &armpostgresqlflexibleservers.Network{
		// 					PublicNetworkAccess: to.Ptr(armpostgresqlflexibleservers.ServerPublicNetworkAccessStateEnabled),
		// 				},
		// 				Replica: &armpostgresqlflexibleservers.Replica{
		// 					Capacity: to.Ptr[int32](0),
		// 					ReplicationState: to.Ptr(armpostgresqlflexibleservers.ReplicationStateActive),
		// 					Role: to.Ptr(armpostgresqlflexibleservers.ReplicationRoleAsyncReplica),
		// 				},
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr(armpostgresqlflexibleservers.ReplicationRoleAsyncReplica),
		// 				State: to.Ptr(armpostgresqlflexibleservers.ServerStateReady),
		// 				Storage: &armpostgresqlflexibleservers.Storage{
		// 					AutoGrow: to.Ptr(armpostgresqlflexibleservers.StorageAutoGrowDisabled),
		// 					Iops: to.Ptr[int32](2300),
		// 					StorageSizeGB: to.Ptr[int32](512),
		// 					Tier: to.Ptr(armpostgresqlflexibleservers.AzureManagedDiskPerformanceTierP20),
		// 				},
		// 				Version: to.Ptr(armpostgresqlflexibleservers.PostgresMajorVersionSeventeen),
		// 			},
		// 			SKU: &armpostgresqlflexibleservers.SKU{
		// 				Name: to.Ptr("Standard_D4ds_v5"),
		// 				Tier: to.Ptr(armpostgresqlflexibleservers.SKUTierGeneralPurpose),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists all read replicas of a server.
 *
 * @summary Lists all read replicas of a server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ReplicasListByServer.json
 */
async function listAllReadReplicasOfAServer() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "exampleresourcegroup";
  const serverName = "exampleserver";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.replicas.listByServer(resourceGroupName, serverName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.PostgreSql.FlexibleServers.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.PostgreSql.FlexibleServers;

// Generated from example definition: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ReplicasListByServer.json
// this example is just showing the usage of "Replicas_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "exampleresourcegroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this PostgreSqlFlexibleServerResource
PostgreSqlFlexibleServerCollection collection = resourceGroupResource.GetPostgreSqlFlexibleServers();

// invoke the operation and iterate over the result
string serverName = "exampleserver";
await foreach (PostgreSqlFlexibleServerResource item in collection.GetReplicasAsync(serverName))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    PostgreSqlFlexibleServerData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "name": "exampleserver",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver",
      "location": "eastus",
      "properties": {
        "administratorLogin": "exampleadministratorlogin",
        "authConfig": {
          "activeDirectoryAuth": "Disabled",
          "passwordAuth": "Enabled"
        },
        "availabilityZone": "2",
        "backup": {
          "backupRetentionDays": 7,
          "earliestRestoreDate": "2025-06-01T18:35:22.123456Z",
          "geoRedundantBackup": "Disabled"
        },
        "dataEncryption": {
          "type": "SystemManaged"
        },
        "fullyQualifiedDomainName": "exampleserver.postgres.database.azure.com",
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "minorVersion": "5",
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "replica": {
          "capacity": 0,
          "replicationState": "Active",
          "role": "AsyncReplica"
        },
        "replicaCapacity": 0,
        "replicationRole": "AsyncReplica",
        "state": "Ready",
        "storage": {
          "autoGrow": "Disabled",
          "iops": 2300,
          "storageSizeGB": 512,
          "tier": "P20"
        },
        "version": "17"
      },
      "sku": {
        "name": "Standard_D4ds_v5",
        "tier": "GeneralPurpose"
      }
    }
  ]
}

Définitions

Nom	Description
AuthConfig	Propriétés de configuration de l’authentification d’un serveur.
AzureManagedDiskPerformanceTier	Niveau de stockage d’un serveur.
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 nouveau serveur.
DataEncryption	Propriétés de chiffrement des données d’un serveur.
DataEncryptionType	Type de chiffrement des données utilisé par un serveur.
EncryptionKeyStatus	État de la clé utilisée par un serveur configuré avec le chiffrement des données basé sur la clé gérée par le client, pour chiffrer le stockage principal associé au serveur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GeographicallyRedundantBackup	Indique si le serveur est configuré pour créer des sauvegardes géographiquement redondantes.
HighAvailability	Propriétés de haute disponibilité d’un serveur.
HighAvailabilityState	États possibles du serveur de secours créé lorsque la haute disponibilité est définie sur SameZone ou ZoneRedundant.
IdentityType	Types d’identités associées à un serveur.
MaintenanceWindow	Propriétés de la fenêtre de maintenance d’un serveur.
MicrosoftEntraAuth	Indique si le serveur prend en chargement l’authentification Microsoft Entra.
Network	Propriétés réseau d’un serveur.
PasswordBasedAuth	Indique si le serveur prend en charge l’authentification par mot de passe.
PostgresMajorVersion	Version majeure du moteur de base de données PostgreSQL.
PostgreSqlFlexibleServerHighAvailabilityMode	Mode de haute disponibilité pris en charge pour ce calcul.
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	Type d’opération à appliquer sur le réplica en lecture. Cette propriété est en écriture uniquement.
ReadReplicaPromoteOption	Option de synchronisation des données à utiliser lors du traitement de l’opération spécifiée dans la propriété promoteMode. Cette propriété est en écriture uniquement.
Replica	Propriétés du réplica d’un serveur.
ReplicationRole	Rôle du serveur dans un jeu de réplication.
ReplicationState	Indique l’état de réplication d’un réplica en lecture. Cette propriété n’est renvoyée que lorsque le serveur cible est un réplica en lecture.
Server	Propriétés d’un serveur.
ServerList	Liste des serveurs.
ServerPublicNetworkAccessState	Indique si l’accès au réseau public est activé ou non.
ServerState	État d’un serveur.
Sku	Calculez les informations d’un serveur.
SkuTier	Niveau du calcul attribué à un serveur.
Storage	Propriétés de stockage d’un serveur.
StorageAutoGrow	Indique si le serveur est configuré pour augmenter automatiquement la taille du stockage lorsque l’espace disponible approche de zéro et que les conditions permettent une croissance automatique de la taille du stockage.
StorageType	Type de stockage attribué à un serveur. S’il n’est pas spécifié, il est défini par défaut sur Premium_LRS.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UserAssignedIdentity	Identités associées à un serveur.
UserIdentity	Identité managée affectée par l’utilisateur associée à un serveur.

AuthConfig

Objet

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

Nom	Type	Valeur par défaut	Description
activeDirectoryAuth	MicrosoftEntraAuth		Indique si le serveur prend en chargement l’authentification Microsoft Entra.
passwordAuth	PasswordBasedAuth	Enabled	Indique si le serveur prend en charge l’authentification par mot de passe.
tenantId	string		Identificateur du locataire de la ressource déléguée.

AzureManagedDiskPerformanceTier

Énumération

Niveau de stockage d’un serveur.

Valeur	Description
P1	SSD d’entrée de gamme pour un minimum d’IOPS, idéal pour les charges de travail de développement ou de test légères.
P2	IOPS légèrement plus élevés pour les applications à petite échelle nécessitant une faible latence constante.
P3	Performances équilibrées pour les charges de travail de production de base avec un débit modéré.
P4	IOPS améliorées pour les applications en pleine croissance avec des besoins de performances prévisibles.
P6	SSD de milieu de gamme pour des charges de travail stables nécessitant un débit et une latence fiables.
P10	Choix populaire pour les charges de travail de production à usage général avec des performances évolutives.
P15	Niveau d’IOPS élevé pour les applications exigeantes avec des opérations de lecture/écriture fréquentes.
P20	Point d’entrée pour les disques SSD hautes performances, adaptés aux charges de travail gourmandes en E/S à petite échelle.
P30	Niveau équilibré pour les applications sensibles au débit modéré et à la latence.
P40	Performances améliorées pour les charges de travail de production croissantes avec des demandes d’IOPS cohérentes.
P50	Optimisé pour les applications d’entreprise nécessitant un débit élevé et soutenu.
P60	Niveau haute capacité pour les bases de données volumineuses et les charges de travail d’analyse avec des IOPS élevés.
P70	Conçu pour les systèmes critiques nécessitant une latence ultra-faible et une simultanéité élevée.
P80	SSD de premier plan pour des IOPS et un débit maximaux, idéal pour les charges de travail les plus exigeantes.

Backup

Objet

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

Nom	Type	Valeur par défaut	Description
backupRetentionDays	integer (int32)	7	Jours de rétention de sauvegarde pour le serveur.
earliestRestoreDate	string (date-time)		Heure du point de restauration le plus ancien (format ISO8601) pour un serveur.
geoRedundantBackup	GeographicallyRedundantBackup	Disabled	Indique si le serveur est configuré pour créer des sauvegardes géographiquement redondantes.

Cluster

Objet

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

Nom	Type	Valeur par défaut	Description
clusterSize	integer (int32)	0	Nombre de nœuds affectés au cluster élastique.
defaultDatabaseName	string		Nom de base de données par défaut du cluster élastique.

createdByType

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

CreateMode

Énumération

Mode de création d’un nouveau serveur.

Valeur	Description
Default	Si l’opération est déclenchée sur un serveur inexistant, elle équivaut à 'Create'. Si l’opération est déclenchée sur un serveur existant, elle équivaut à 'Update'.
Create	L’opération crée un serveur.
Update	L’opération met à jour un serveur existant.
PointInTimeRestore	Operation restaure une sauvegarde existante d’un serveur existant. Cette opération crée un nouveau serveur, puis restaure sur celui-ci la sauvegarde d’un serveur existant à un moment précis.
GeoRestore	Operation restaure une sauvegarde existante d’un serveur existant, sur la région appariée du serveur existant. Cette opération crée un nouveau serveur sur la région appariée du serveur existant, puis restaure sur celui-ci la sauvegarde d’un serveur existant à un moment précis, dans une région différente. Cette opération n’est prise en charge que sur les serveurs existants qui ont été créés avec des sauvegardes géographiquement redondantes activées.
Replica	L’opération crée une réplique d’un serveur existant. Cette opération crée un serveur, restaure une sauvegarde de base du serveur existant (appelée serveur principal) et configure la réplication physique pour diffuser de manière asynchrone toutes les modifications enregistrées dans le journal de transactions du serveur principal.
ReviveDropped	Operation crée un nouveau serveur, initialisé avec la sauvegarde d’un serveur récemment supprimé.

DataEncryption

Objet

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

Nom	Type	Description
geoBackupEncryptionKeyStatus	EncryptionKeyStatus	État de la clé utilisée par un serveur configuré avec le chiffrement des données basé sur la clé gérée par le client, pour chiffrer le stockage géographiquement redondant associé au serveur lorsqu’il est configuré pour prendre en charge des sauvegardes géographiquement redondantes.
geoBackupKeyURI	string	Identifiant de l’identité managée attribuée par l’utilisateur utilisé pour accéder à la clé dans Azure Key Vault pour le chiffrement des données du stockage géographiquement redondant associé à un serveur configuré pour supporter des sauvegardes géographiquement redondantes.
geoBackupUserAssignedIdentityId	string	Identifiant de l’identité managée attribuée par l’utilisateur utilisé pour accéder à la clé dans Azure Key Vault pour le chiffrement des données du stockage géographiquement redondant associé à un serveur configuré pour supporter des sauvegardes géographiquement redondantes.
primaryEncryptionKeyStatus	EncryptionKeyStatus	État de la clé utilisée par un serveur configuré avec le chiffrement des données basé sur la clé gérée par le client, pour chiffrer le stockage principal associé au serveur.
primaryKeyURI	string	URI de la clé dans Azure Key Vault utilisée pour le chiffrement des données du stockage principal associé à un serveur.
primaryUserAssignedIdentityId	string	Identifiant de l’identité managée attribuée par l’utilisateur utilisé pour accéder à la clé dans Azure Key Vault pour le chiffrement des données du stockage principal associé à un serveur.
type	DataEncryptionType	Type de chiffrement des données utilisé par un serveur.

DataEncryptionType

Énumération

Type de chiffrement des données utilisé par un serveur.

Valeur	Description
SystemManaged	Le chiffrement est géré par Azure en utilisant des clés gérées par plateforme pour simplifier et conformité.
AzureKeyVault	Le chiffrement utilisant des clés gérées par le client stockées dans Azure Key Vault pour un contrôle et une sécurité accrus.

EncryptionKeyStatus

Énumération

État de la clé utilisée par un serveur configuré avec le chiffrement des données basé sur la clé gérée par le client, pour chiffrer le stockage principal associé au serveur.

Valeur	Description
Valid	La clé est valide et peut être utilisée pour le cryptage.
Invalid	La clé n’est pas valide et ne peut pas être utilisée pour le chiffrement. Les causes possibles incluent la suppression de clés, les modifications d’autorisation, la désactivation de la clé, le type de clé non pris en charge ou la date actuelle en dehors de la période de validité associée à la clé.

ErrorAdditionalInfo

Objet

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

Objet

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

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

GeographicallyRedundantBackup

Énumération

Indique si le serveur est configuré pour créer des sauvegardes géographiquement redondantes.

Valeur	Description
Enabled	Le serveur est configuré pour créer des sauvegardes géographiquement redondantes.
Disabled	Le serveur n’est pas configuré pour créer des sauvegardes géographiquement redondantes.

HighAvailability

Objet

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

Nom	Type	Valeur par défaut	Description
mode	PostgreSqlFlexibleServerHighAvailabilityMode	Disabled	Mode haute disponibilité pour un serveur.
standbyAvailabilityZone	string		Zone de disponibilité associée au serveur de secours créée lorsque la haute disponibilité est définie sur SameZone ou ZoneRedundant.
state	HighAvailabilityState		États possibles du serveur de secours créé lorsque la haute disponibilité est définie sur SameZone ou ZoneRedundant.

HighAvailabilityState

Énumération

États possibles du serveur de secours créé lorsque la haute disponibilité est définie sur SameZone ou ZoneRedundant.

Valeur	Description
NotEnabled	La haute disponibilité n’est pas activée pour le serveur.
CreatingStandby	Un serveur de secours est en cours de création.
ReplicatingData	Les données sont répliquées sur le serveur de secours.
FailingOver	L’opération de basculement vers le serveur de secours est en cours.
Healthy	Le serveur de secours est sain et prêt à prendre le relais en cas de basculement.
RemovingStandby	Le serveur de secours est en cours de suppression.
RecreatingStandby	Le serveur de veille est en cours de recréation.
ComputeUpdatingByFailover	Le calcul est mis à jour à cause d’un basculement.

IdentityType

Énumération

Types d’identités associées à un serveur.

Valeur	Description
None	Aucune identité managée n’est attribuée au serveur.
UserAssigned	Une ou plusieurs identités gérées fournies par l’utilisateur sont affectées au serveur.
SystemAssigned	Azure crée et gère automatiquement l’identité associée au cycle de vie du serveur.
SystemAssigned,UserAssigned	Les identités affectées par le système et par l’utilisateur sont affectées au serveur.

MaintenanceWindow

Objet

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 (int32)	0	Jour de la semaine à utiliser pour la fenêtre de maintenance.
startHour	integer (int32)	0	Heure de début à utiliser pour la fenêtre de maintenance.
startMinute	integer (int32)	0	Minute de départ à utiliser pour la fenêtre de maintenance.

MicrosoftEntraAuth

Énumération

Indique si le serveur prend en chargement l’authentification Microsoft Entra.

Valeur	Description
Enabled	Le serveur prend en compte l’authentification Microsoft Entra.
Disabled	Le serveur ne prend pas en charge l’authentification Microsoft Entra.

Network

Objet

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

Nom	Type	Description
delegatedSubnetResourceId	string (arm-id)	Identificateur de ressource du sous-réseau délégué. Nécessaire lors de la création d’un nouveau serveur, au cas où vous souhaiteriez que le serveur soit intégré dans votre propre réseau virtuel. Pour une opération de mise à jour, vous n’avez qu’à fournir cette propriété si vous souhaitez modifier la valeur attribuée à la zone DNS privée.
privateDnsZoneArmResourceId	string (arm-id)	Identifiant de la zone DNS privée. Nécessaire lors de la création d’un nouveau serveur, au cas où vous souhaiteriez que le serveur soit intégré dans votre propre réseau virtuel. Pour une opération de mise à jour, vous n’avez qu’à fournir cette propriété si vous souhaitez modifier la valeur attribuée à la zone DNS privée.
publicNetworkAccess	ServerPublicNetworkAccessState	Indique si l’accès au réseau public est activé ou non. Ceci n’est pris en charge que pour les serveurs qui ne sont pas intégrés dans un réseau virtuel appartenant au client et fourni par celui-ci lors du déploiement du serveur.

PasswordBasedAuth

Énumération

Indique si le serveur prend en charge l’authentification par mot de passe.

Valeur	Description
Enabled	Server prend en charge l’authentification par mot de passe.
Disabled	Le serveur ne prend pas en charge l’authentification basée sur un mot de passe.

PostgresMajorVersion

Énumération

Version majeure du moteur de base de données PostgreSQL.

Valeur	Description
18	PostgreSQL 18.
17	PostgreSQL 17.
16	PostgreSQL 16.
15	PostgreSQL 15.
14	PostgreSQL 14.
13	PostgreSQL 13.
12	PostgreSQL 12.
11	PostgreSQL 11.

PostgreSqlFlexibleServerHighAvailabilityMode

Énumération

Mode de haute disponibilité pris en charge pour ce calcul.

Valeur	Description
Disabled	La haute disponibilité est désactivée pour le serveur.
ZoneRedundant	La haute disponibilité est activée pour le serveur, avec le serveur de secours dans une zone de disponibilité différente de celle du serveur principal.
SameZone	La haute disponibilité est activée pour le serveur, le serveur de secours se trouvant dans la même zone de disponibilité que le serveur principal.

PrivateEndpoint

Objet

Ressource de point de terminaison privé.

Nom	Type	Description
id	string	Identificateur ARM pour le point de terminaison privé.

PrivateEndpointConnection

Objet

Ressource de connexion de point de terminaison privé.

Nom	Type	Description
id	string (arm-id)	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	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

PrivateEndpointConnectionProvisioningState

Énumération

État d’approvisionnement actuel.

Valeur	Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Énumération

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

Valeur	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objet

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

Énumération

Type d’opération à appliquer sur le réplica en lecture. Cette propriété est en écriture uniquement.

Valeur	Description
Standalone	La réplique en lecture deviendra un serveur indépendant, et une entité totalement indépendante de l’ensemble de réplication.
Switchover	Le réplica en lecture échangera les rôles avec le serveur principal.

ReadReplicaPromoteOption

Énumération

Option de synchronisation des données à utiliser lors du traitement de l’opération spécifiée dans la propriété promoteMode. Cette propriété est en écriture uniquement.

Valeur	Description
Planned	Attendez que les données dans la réplique de lecture soient entièrement synchronisées avec son serveur source avant qu’il ne lance l’opération.
Forced	Lancer l’opération immédiatement, sans attendre que les données de la réplique lue soient synchronisées avec son serveur source.

Replica

Objet

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

Nom	Type	Description
capacity	integer (int32)	Nombre maximal de répliques en lecture autorisées pour un serveur.
promoteMode	ReadReplicaPromoteMode	Type d’opération à appliquer sur le réplica en lecture. Cette propriété est en écriture uniquement. Autonome signifie que le réplica en lecture sera promu en tant que serveur autonome et deviendra une entité complètement indépendante du jeu de réplication. Le basculement signifie que le réplica en lecture sera affecté au serveur principal.
promoteOption	ReadReplicaPromoteOption	Option de synchronisation des données à utiliser lors du traitement de l’opération spécifiée dans la propriété promoteMode. Cette propriété est en écriture uniquement.
replicationState	ReplicationState	Indique l’état de réplication d’un réplica en lecture. Cette propriété n’est renvoyée que lorsque le serveur cible est un réplica en lecture. Les valeurs possibles sont Actif, Rompu, Rattrapage, Provisionnement, Reconfiguration et Mise à jour
role	ReplicationRole	Rôle du serveur dans un jeu de réplication.

ReplicationRole

Énumération

Rôle du serveur dans un jeu de réplication.

Valeur	Description
None	Aucun rôle de réplication attribué ; Le serveur fonctionne indépendamment.
Primary	Agit en tant que serveur source pour la réplication vers une ou plusieurs répliques.
AsyncReplica	Reçoit des données de manière asynchrone à partir d’un serveur principal au sein de la même région.
GeoAsyncReplica	Reçoit des données de manière asynchrone à partir d’un serveur principal situé dans une autre région à des fins de redondance géographique.

ReplicationState

Énumération

Indique l’état de réplication d’un réplica en lecture. Cette propriété n’est renvoyée que lorsque le serveur cible est un réplica en lecture.

Valeur	Description
Active	Le serveur de réplique en lecture est entièrement synchronisé et réplique activement les données du serveur principal.
Catchup	Le serveur de réplice en lecture est en retard sur le serveur principal et rattrape actuellement les changements en cours.
Provisioning	Un serveur de réplice en lecture est en cours de création et est en cours d’initialisation.
Updating	Le serveur de réplique lu subit quelques changements, il peut y avoir des modifications de la taille de calcul ou la promotion vers le serveur principal.
Broken	La réplication a échoué ou a été interrompue.
Reconfiguring	Le serveur de réplices en lecture est en cours de reconfiguration, probablement en raison de changements de source ou de paramètres.

Server

Objet

Propriétés d’un serveur.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
identity	UserAssignedIdentity	Identités managées affectées par l’utilisateur affectées au serveur.
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.administratorLogin	string	Nom du login désigné comme premier administrateur basé sur un mot de passe attribué à votre instance de PostgreSQL. Doit être spécifié la première fois que vous activez l’authentification par mot de passe sur un serveur. Une fois défini sur une valeur donnée, il ne peut pas être modifié pour le reste de la vie d’un serveur. Si vous désactivez l’authentification par mot de passe sur un serveur sur lequel elle est activée, ce rôle basé sur un mot de passe n’est pas supprimé.
properties.administratorLoginPassword	string (password)	Mot de passe attribué à la connexion administrateur. Tant que l’authentification par mot de passe est activée, ce mot de passe peut être modifié à tout moment.
properties.authConfig	AuthConfig	Propriétés de configuration de l’authentification d’un serveur.
properties.availabilityZone	string	Zone de disponibilité d’un 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 nouveau serveur.
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 moteur de base de données PostgreSQL.
properties.network	Network	Propriétés réseau d’un serveur. Requis uniquement si vous souhaitez que votre serveur soit intégré dans un réseau virtuel fourni par le client.
properties.pointInTimeUTC	string (date-time)	Heure de création (au format ISO8601) de la sauvegarde que vous souhaitez restaurer sur le nouveau serveur. Il est requis lorsque 'createMode' est 'PointInTimeRestore', 'GeoRestore' ou 'ReviveDropped'.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Liste des connexions de point de terminaison privées associées au serveur spécifié.
properties.replica	Replica	Lire les propriétés de réplica d’un serveur. Requis uniquement si vous souhaitez promouvoir un serveur.
properties.replicaCapacity	integer (int32)	Nombre maximal de répliques en lecture autorisées pour un serveur.
properties.replicationRole	ReplicationRole	Rôle du serveur dans un jeu de réplication.
properties.sourceServerResourceId	string (arm-id)	Identifiant du serveur à utiliser comme source du nouveau serveur. Obligatoire lorsque 'createMode' est 'PointInTimeRestore', 'GeoRestore', 'Replica' ou 'ReviveDropped'. Cette propriété n’est renvoyée que lorsque le serveur cible est un réplica en lecture.
properties.state	ServerState	États possibles d’un serveur.
properties.storage	Storage	Propriétés de stockage d’un serveur.
properties.version	PostgresMajorVersion	Version majeure du moteur de base de données PostgreSQL.
sku	Sku	Niveau de calcul et taille d’un serveur.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

ServerList

Objet

Liste des serveurs.

Nom	Type	Description
nextLink	string (uri)	Le lien vers la page suivante des éléments
value	Server[]	Les éléments du serveur sur cette page

ServerPublicNetworkAccessState

Énumération

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

Valeur	Description
Enabled	L’accès au réseau public est activé. Cela permet d’accéder au serveur à partir de l’Internet public, à condition que la règle de pare-feu nécessaire qui autorise le trafic entrant provenant du client de connexion soit en place. Ceci est compatible avec l’utilisation de points de terminaison privés pour se connecter à ce serveur.
Disabled	L’accès au réseau public est désactivé. Cela signifie que le serveur n’est pas accessible à partir de l’Internet public, mais uniquement via des points de terminaison privés.

ServerState

Énumération

État d’un serveur.

Valeur	Description
Ready	Le serveur est sain et ne subit aucune opération au niveau de la gestion ou du plan de contrôle. Cela ne signifie pas que le serveur est pleinement opérationnel au niveau du plan de données.
Dropping	Le serveur est en cours de suppression.
Disabled	Le serveur est désactivé. Les raisons typiques sont les suivantes : l’abonnement sur lequel le serveur est déployé est explicitement désactivé ou annulé par l’administrateur, la limite de dépenses a été atteinte ou la facture est en retard. Cela peut également se produire lorsque le serveur est déplacé vers un autre groupe de ressources ou un autre abonnement.
Starting	Le moteur de base de données PostgreSQL est en cours de redémarrage.
Stopping	Les ressources de calcul associées au serveur sont arrêtées et désallouées. Si la haute disponibilité est activée sur le serveur, les ressources de calcul du serveur de secours sont également arrêtées et désallouées.
Stopped	Les ressources de calcul associées au serveur sont arrêtées et désallouées.
Updating	Le serveur subit des modifications qui peuvent ou non avoir un impact sur la disponibilité du moteur de base de données PostgreSQL. Par exemple, les ressources de calcul du serveur sont augmentées ou réduites, ce qui peut entraîner une indisponibilité temporaire du moteur de base de données. Ou, par exemple, une règle de pare-feu est ajoutée ou supprimée, ce qui n’entraîne pas d’indisponibilité du moteur de base de données.
Restarting	Le moteur de base de données PostgreSQL est en cours de redémarrage.
Inaccessible	Le serveur n’est pas accessible, car la clé fournie pour chiffrer et déchiffrer les données n’est pas valide.
Provisioning	Le serveur est en cours de création.

Sku

Objet

Calculez les informations d’un serveur.

Nom	Type	Description
name	string	Nom par lequel est connue une taille de calcul donnée attribuée à un serveur.
tier	SkuTier	Niveau du calcul attribué à un serveur.

SkuTier

Énumération

Niveau du calcul attribué à un serveur.

Valeur	Description
Burstable	Niveau économique pour une utilisation peu fréquente du processeur, idéal pour le développement et le test de charges de travail avec de faibles exigences de performances.
GeneralPurpose	Calcul et mémoire équilibrés pour la plupart des charges de travail, offrant des performances et un débit d’E/S évolutifs.
MemoryOptimized	Rapport mémoire/cœur élevé pour les charges de travail exigeantes nécessitant un traitement en mémoire rapide et une simultanéité élevée.

Storage

Objet

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

Nom	Type	Description
autoGrow	StorageAutoGrow	Activez ou désactivez l’augmentation automatique de la taille de stockage d’un serveur lorsque l’espace disponible est proche de zéro et que les conditions permettent d’augmenter automatiquement la taille de stockage.
iops	integer (int32)	IOPS maximum pris en charge pour le stockage. Requis lorsque le type de stockage est PremiumV2_LRS ou UltraSSD_LRS.
storageSizeGB	integer (int32)	Taille du stockage attribué à un serveur.
throughput	integer (int32)	Débit maximal pris en charge pour le stockage. Requis lorsque le type de stockage est PremiumV2_LRS ou UltraSSD_LRS.
tier	AzureManagedDiskPerformanceTier	Niveau de stockage d’un serveur.
type	StorageType	Type de stockage attribué à un serveur. Les valeurs autorisées sont Premium_LRS, PremiumV2_LRS ou UltraSSD_LRS. S’il n’est pas spécifié, il est défini par défaut sur Premium_LRS.

StorageAutoGrow

Énumération

Indique si le serveur est configuré pour augmenter automatiquement la taille du stockage lorsque l’espace disponible approche de zéro et que les conditions permettent une croissance automatique de la taille du stockage.

Valeur	Description
Enabled	Le serveur doit augmenter automatiquement la taille du stockage lorsque l’espace disponible est proche de zéro et que les conditions permettent d’augmenter automatiquement la taille du stockage.
Disabled	Le serveur ne doit pas augmenter automatiquement la taille du stockage lorsque l’espace disponible est proche de zéro.

StorageType

Énumération

Type de stockage attribué à un serveur. S’il n’est pas spécifié, il est défini par défaut sur Premium_LRS.

Valeur	Description
Premium_LRS	Le stockage standard sur disque SSD (Solid State Disk) offre des performances constantes pour les charges de travail à usage général.
PremiumV2_LRS	Stockage sur disque dur (SSD) de nouvelle génération avec une évolutivité et des performances améliorées pour les charges de travail d’entreprise exigeantes.
UltraSSD_LRS	Stockage sur disque dur (SSD) haut de gamme conçu pour les IOPS extrêmes et les applications sensibles à la latence.

systemData

Objet

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

Nom	Type	Description
createdAt	string (date-time)	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 (date-time)	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

Objet

Identités associées à un serveur.

Nom	Type	Description
principalId	string	Identificateur de l’objet du principal de service associé à l’identité managée affectée par l’utilisateur.
tenantId	string	Identifiant du locataire d’un serveur.
type	IdentityType	Types d’identités associées à un serveur.
userAssignedIdentities	<string,  UserIdentity>	Carte des identités gérées attribuées par l’utilisateur.

UserIdentity

Objet

Identité managée affectée par l’utilisateur associée à un serveur.

Nom	Type	Description
clientId	string	Identificateur du client du principal de service associé à l’identité managée affectée par l’utilisateur.
principalId	string	Identificateur de l’objet du principal de service associé à l’identité managée affectée par l’utilisateur.