Replicas - List By Server

Servicio:

PostgreSQL

Versión de la API:

2025-08-01

Enumera todas las réplicas de lectura de un servidor.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	El nombre del servidor.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	ServerList	Operación de Azure completada con éxito.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List all read replicas of a server.

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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": "18"
      },
      "sku": {
        "name": "Standard_D4ds_v5",
        "tier": "GeneralPurpose"
      }
    }
  ]
}

Definiciones

Nombre	Description
AuthConfig	Propiedades de configuración de autenticación de un servidor.
AzureManagedDiskPerformanceTier	Nivel de almacenamiento de un servidor.
Backup	Propiedades de copia de seguridad de un servidor.
Cluster	Propiedades de clúster de un servidor.
createdByType	Tipo de identidad que creó el recurso.
CreateMode	Modo de creación de un nuevo servidor.
DataEncryption	Propiedades de cifrado de datos de un servidor.
DataEncryptionType	Tipo de cifrado de datos utilizado por un servidor.
EncryptionKeyStatus	Estado de la clave utilizada por un servidor configurado con cifrado de datos basado en la clave administrada por el cliente, para cifrar el almacenamiento principal asociado al servidor.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GeographicallyRedundantBackup	Indica si el servidor está configurado para crear copias de seguridad con redundancia geográfica.
HighAvailability	Propiedades de alta disponibilidad de un servidor.
HighAvailabilityState	Posibles estados del servidor en espera creado cuando la alta disponibilidad se establece en SameZone o ZoneRedundant.
IdentityType	Tipos de identidades asociadas a un servidor.
MaintenanceWindow	Propiedades de la ventana de mantenimiento de un servidor.
MicrosoftEntraAuth	Indica si el servidor soporta autenticación Microsoft Entra.
Network	Propiedades de red de un servidor.
PasswordBasedAuth	Indica si el servidor admite la autenticación basada en contraseña.
PostgresMajorVersion	Versión principal del motor de base de datos PostgreSQL.
PostgreSqlFlexibleServerHighAvailabilityMode	Modo de alta disponibilidad soportado para este cálculo.
PrivateEndpoint	Recurso de punto de conexión privado.
PrivateEndpointConnection	Recurso de conexión de punto de conexión privado.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual.
PrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
ReadReplicaPromoteMode	Tipo de operación que se va a aplicar en la réplica de lectura. Esta propiedad es de solo escritura.
ReadReplicaPromoteOption	Opción de sincronización de datos que se usará al procesar la operación especificada en la propiedad promoteMode. Esta propiedad es de solo escritura.
Replica	Propiedades de réplica de un servidor.
ReplicationRole	Rol del servidor en un conjunto de replicación.
ReplicationState	Indica el estado de replicación de una réplica de lectura. Esta propiedad solo se devuelve cuando el servidor de destino es una réplica de lectura.
Server	Propiedades de un servidor.
ServerList	Lista de servidores.
ServerPublicNetworkAccessState	Indica si el acceso a la red pública está habilitado o no.
ServerState	Estado de un servidor.
Sku	Información informática de un servidor.
SkuTier	Nivel del proceso asignado a un servidor.
Storage	Propiedades de almacenamiento de un servidor.
StorageAutoGrow	Indica si el servidor está configurado para aumentar automáticamente el tamaño del almacenamiento cuando el espacio disponible está cerca de cero y las condiciones permiten un crecimiento automático del tamaño del almacenamiento.
StorageType	Tipo de almacenamiento asignado a un servidor. Si no se especifica, el valor predeterminado es Premium_LRS.
systemData	Metadatos relativos a la creación y última modificación del recurso.
UserAssignedIdentity	Identidades asociadas a un servidor.
UserIdentity	Identidad administrada asignada por el usuario asociada a un servidor.

AuthConfig

Objeto

Propiedades de configuración de autenticación de un servidor.

Nombre	Tipo	Valor predeterminado	Description
activeDirectoryAuth	MicrosoftEntraAuth		Indica si el servidor soporta autenticación Microsoft Entra.
passwordAuth	PasswordBasedAuth	Enabled	Indica si el servidor admite la autenticación basada en contraseña.
tenantId	string		Identificador del inquilino del recurso delegado.

AzureManagedDiskPerformanceTier

Enumeración

Nivel de almacenamiento de un servidor.

Valor	Description
P1	SSD de nivel básico para IOPS mínimas, ideal para cargas de trabajo ligeras de desarrollo o pruebas.
P2	IOPS ligeramente más altas para aplicaciones a pequeña escala que necesitan una baja latencia constante.
P3	Rendimiento equilibrado para cargas de trabajo de producción básicas con un rendimiento moderado.
P4	IOPS mejoradas para aplicaciones en crecimiento con necesidades de rendimiento predecibles.
P6	SSD de nivel medio para cargas de trabajo estables que requieren un rendimiento y una latencia fiables.
P10	Opción popular para cargas de trabajo de producción de uso general con rendimiento escalable.
P15	Nivel de IOPS alto para aplicaciones exigentes con operaciones de lectura y escritura frecuentes.
P20	Punto de entrada para discos de estado sólido (SSD) de alto rendimiento, adecuado para cargas de trabajo intensivas de E/S a pequeña escala.
P30	Nivel equilibrado para aplicaciones sensibles a la latencia y rendimiento moderado.
P40	Rendimiento mejorado para cargas de trabajo de producción crecientes con demandas de IOPS consistentes.
P50	Optimizado para aplicaciones de nivel empresarial que necesitan un alto rendimiento sostenido.
P60	Nivel de alta capacidad para grandes bases de datos y cargas de trabajo de análisis con IOPS elevadas.
P70	Diseñado para sistemas de misión crítica que requieren una latencia ultrabaja y una alta simultaneidad.
P80	SSD de primer nivel para obtener el máximo rendimiento e IOPS, ideal para las cargas de trabajo más exigentes.

Backup

Objeto

Propiedades de copia de seguridad de un servidor.

Nombre	Tipo	Valor predeterminado	Description
backupRetentionDays	integer (int32)	7	Días de retención de copia de seguridad para el servidor.
earliestRestoreDate	string (date-time)		Hora de punto de restauración más temprana (formato ISO8601) para un servidor.
geoRedundantBackup	GeographicallyRedundantBackup	Disabled	Indica si el servidor está configurado para crear copias de seguridad con redundancia geográfica.

Cluster

Objeto

Propiedades de clúster de un servidor.

Nombre	Tipo	Valor predeterminado	Description
clusterSize	integer (int32)	0	Número de nodos asignados al clúster elástico.
defaultDatabaseName	string		Nombre de base de datos predeterminado para el clúster elástico.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CreateMode

Enumeración

Modo de creación de un nuevo servidor.

Valor	Description
Default	Si la operación se activa en un servidor no existente, es equivalente a "Crear". Si la operación se activa en un servidor existente, es equivalente a "Actualizar".
Create	La operación crea un nuevo servidor.
Update	La operación actualiza un servidor existente.
PointInTimeRestore	La operación restaura una copia de seguridad existente de un servidor existente. Esta operación crea un nuevo servidor y, a continuación, restaura en él la copia de seguridad de un servidor existente en un momento específico.
GeoRestore	La operación restaura una copia de seguridad existente de un servidor existente, en la región emparejada del servidor existente. Esta operación crea un nuevo servidor en la región emparejada del servidor existente y, a continuación, restaura en él la copia de seguridad de un servidor existente en un momento específico, en una región diferente. Esta operación solo se admite en servidores existentes que se crearon con copias de seguridad con redundancia geográfica habilitadas.
Replica	La operación crea una réplica de un servidor existente. Esta operación crea un nuevo servidor, restaura una copia de seguridad base del servidor existente (denominado principal) y configura la replicación física para transmitir de forma asincrónica todos los cambios registrados en el registro de transacciones del principal.
ReviveDropped	La operación crea un nuevo servidor, inicializado con la copia de seguridad de un servidor que se eliminó recientemente.

DataEncryption

Objeto

Propiedades de cifrado de datos de un servidor.

Nombre	Tipo	Description
geoBackupEncryptionKeyStatus	EncryptionKeyStatus	Estado de la clave utilizada por un servidor configurado con cifrado de datos basado en la clave administrada por el cliente, para cifrar el almacenamiento geográficamente redundante asociado al servidor cuando está configurado para admitir copias de seguridad geográficamente redundantes.
geoBackupKeyURI	string	Identificador de la identidad gestionada asignada por el usuario usado para acceder a la clave en Azure Key Vault para el cifrado de datos del almacenamiento geográficamente redundante asociado a un servidor configurado para soportar copias de seguridad geográficamente redundantes.
geoBackupUserAssignedIdentityId	string	Identificador de la identidad gestionada asignada por el usuario usado para acceder a la clave en Azure Key Vault para el cifrado de datos del almacenamiento geográficamente redundante asociado a un servidor configurado para soportar copias de seguridad geográficamente redundantes.
primaryEncryptionKeyStatus	EncryptionKeyStatus	Estado de la clave utilizada por un servidor configurado con cifrado de datos basado en la clave administrada por el cliente, para cifrar el almacenamiento principal asociado al servidor.
primaryKeyURI	string	URI de la clave en Azure Key Vault usado para el cifrado de datos del almacenamiento principal asociado a un servidor.
primaryUserAssignedIdentityId	string	Identificador de la identidad gestionada asignada por el usuario usado para acceder a la clave en Azure Key Vault para el cifrado de datos del almacenamiento principal asociado a un servidor.
type	DataEncryptionType	Tipo de cifrado de datos utilizado por un servidor.

DataEncryptionType

Enumeración

Tipo de cifrado de datos utilizado por un servidor.

Valor	Description
SystemManaged	Cifrado gestionado por Azure usando claves gestionadas por plataforma para mayor simplicidad y cumplimiento.
AzureKeyVault	Cifrado usando claves gestionadas por el cliente almacenadas en Azure Key Vault para un mayor control y seguridad.

EncryptionKeyStatus

Enumeración

Estado de la clave utilizada por un servidor configurado con cifrado de datos basado en la clave administrada por el cliente, para cifrar el almacenamiento principal asociado al servidor.

Valor	Description
Valid	La clave es válida y se puede utilizar para el cifrado.
Invalid	La clave no es válida y no se puede utilizar para el cifrado. Las posibles causas incluyen la eliminación de claves, cambios de permisos, clave deshabilitada, tipo de clave no admitido o fecha actual fuera del período de validez asociado a la clave.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GeographicallyRedundantBackup

Enumeración

Indica si el servidor está configurado para crear copias de seguridad con redundancia geográfica.

Valor	Description
Enabled	El servidor está configurado para crear copias de seguridad con redundancia geográfica.
Disabled	El servidor no está configurado para crear copias de seguridad con redundancia geográfica.

HighAvailability

Objeto

Propiedades de alta disponibilidad de un servidor.

Nombre	Tipo	Valor predeterminado	Description
mode	PostgreSqlFlexibleServerHighAvailabilityMode	Disabled	Modo de alta disponibilidad para un servidor.
standbyAvailabilityZone	string		Zona de disponibilidad asociada al servidor en espera creada cuando la alta disponibilidad se establece en SameZone o ZoneRedundant.
state	HighAvailabilityState		Posibles estados del servidor en espera creado cuando la alta disponibilidad se establece en SameZone o ZoneRedundant.

HighAvailabilityState

Enumeración

Posibles estados del servidor en espera creado cuando la alta disponibilidad se establece en SameZone o ZoneRedundant.

Valor	Description
NotEnabled	La alta disponibilidad no está habilitada para el servidor.
CreatingStandby	Se está creando un servidor en espera.
ReplicatingData	Los datos se replican en el servidor en espera.
FailingOver	La operación de conmutación por error al servidor en espera está en curso.
Healthy	El servidor en espera está en buen estado y listo para tomar el control en caso de una conmutación por error.
RemovingStandby	Se está quitando el servidor en espera.
RecreatingStandby	El servidor de espera está siendo recreado.
ComputeUpdatingByFailover	Compute se está actualizando debido a un conmutamiento por error.

IdentityType

Enumeración

Tipos de identidades asociadas a un servidor.

Valor	Description
None	No se asigna ninguna identidad administrada al servidor.
UserAssigned	Una o varias identidades administradas proporcionadas por el usuario se asignan al servidor.
SystemAssigned	Azure crea y gestiona automáticamente la identidad asociada al ciclo de vida del servidor.
SystemAssigned,UserAssigned	Tanto las identidades asignadas por el sistema como las asignadas por el usuario se asignan al servidor.

MaintenanceWindow

Objeto

Propiedades de la ventana de mantenimiento de un servidor.

Nombre	Tipo	Valor predeterminado	Description
customWindow	string	Disabled	Indica si la ventana personalizada está habilitada o deshabilitada.
dayOfWeek	integer (int32)	0	Día de la semana que se utilizará para la ventana de mantenimiento.
startHour	integer (int32)	0	Hora de inicio que se utilizará para la ventana de mantenimiento.
startMinute	integer (int32)	0	Minuto de inicio que se utilizará para la ventana de mantenimiento.

MicrosoftEntraAuth

Enumeración

Indica si el servidor soporta autenticación Microsoft Entra.

Valor	Description
Enabled	El servidor soporta autenticación Microsoft Entra.
Disabled	El servidor no soporta autenticación Microsoft Entra.

Network

Objeto

Propiedades de red de un servidor.

Nombre	Tipo	Description
delegatedSubnetResourceId	string (arm-id)	Identificador de recursos de la subred delegada. Necesario durante la creación de un nuevo servidor, en caso de que desee que el servidor se integre en su propia red virtual. Para una operación de actualización, solo tiene que proporcionar esta propiedad si desea cambiar el valor asignado para la zona DNS privada.
privateDnsZoneArmResourceId	string (arm-id)	Identificador de la zona DNS privada. Necesario durante la creación de un nuevo servidor, en caso de que desee que el servidor se integre en su propia red virtual. Para una operación de actualización, solo tiene que proporcionar esta propiedad si desea cambiar el valor asignado para la zona DNS privada.
publicNetworkAccess	ServerPublicNetworkAccessState	Indica si el acceso a la red pública está habilitado o no. Esto solo se admite para servidores que no están integrados en una red virtual que es propiedad del cliente y proporcionada por el cliente cuando se implementa el servidor.

PasswordBasedAuth

Enumeración

Indica si el servidor admite la autenticación basada en contraseña.

Valor	Description
Enabled	El servidor admite la autenticación basada en contraseña.
Disabled	El servidor no soporta autenticación basada en contraseña.

PostgresMajorVersion

Enumeración

Versión principal del motor de base de datos PostgreSQL.

Valor	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

Enumeración

Modo de alta disponibilidad soportado para este cálculo.

Valor	Description
Disabled	La alta disponibilidad está deshabilitada para el servidor.
ZoneRedundant	La alta disponibilidad está habilitada para el servidor, con el servidor en espera en una zona de disponibilidad diferente a la del principal.
SameZone	La alta disponibilidad está habilitada para el servidor, con el servidor en espera en la misma zona de disponibilidad que el principal.

PrivateEndpoint

Objeto

Recurso de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de ARM para el punto de conexión privado.

PrivateEndpointConnection

Objeto

Recurso de conexión de punto de conexión privado.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.groupIds	string[]	Identificadores de grupo para el recurso de punto de conexión privado.
properties.privateEndpoint	PrivateEndpoint	Recurso de punto de conexión privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento del recurso de conexión de punto de conexión privado.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

PrivateEndpointConnectionProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Enumeración

Estado de conexión del punto de conexión privado.

Valor	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objeto

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Nombre	Tipo	Description
actionsRequired	string	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo de la conexión.
status	PrivateEndpointServiceConnectionStatus	Indica si el propietario del servicio ha aprobado o rechazado o eliminado la conexión.

ReadReplicaPromoteMode

Enumeración

Tipo de operación que se va a aplicar en la réplica de lectura. Esta propiedad es de solo escritura.

Valor	Description
Standalone	La réplica de lectura se convertirá en un servidor independiente y en una entidad completamente independiente del conjunto de replicación.
Switchover	La réplica de lectura intercambiará roles con el servidor principal.

ReadReplicaPromoteOption

Enumeración

Opción de sincronización de datos que se usará al procesar la operación especificada en la propiedad promoteMode. Esta propiedad es de solo escritura.

Valor	Description
Planned	Espera a que los datos en la réplica de lectura estén completamente sincronizados con su servidor de origen antes de iniciar la operación.
Forced	Inicia la operación inmediatamente, sin esperar a que los datos en la réplica de lectura se sincronicen con su servidor de origen.

Replica

Objeto

Propiedades de réplica de un servidor.

Nombre	Tipo	Description
capacity	integer (int32)	Número máximo de réplicas de lectura permitidas para un servidor.
promoteMode	ReadReplicaPromoteMode	Tipo de operación que se va a aplicar en la réplica de lectura. Esta propiedad es de solo escritura. Independiente significa que la réplica de lectura se promoverá a un servidor independiente y se convertirá en una entidad completamente independiente del conjunto de replicación. El cambio significa que la réplica de lectura tendrá roles con el servidor principal.
promoteOption	ReadReplicaPromoteOption	Opción de sincronización de datos que se usará al procesar la operación especificada en la propiedad promoteMode. Esta propiedad es de solo escritura.
replicationState	ReplicationState	Indica el estado de replicación de una réplica de lectura. Esta propiedad solo se devuelve cuando el servidor de destino es una réplica de lectura. Los valores posibles son Activo, Roto, Puesta al día, Aprovisionamiento, Reconfiguración y Actualización
role	ReplicationRole	Rol del servidor en un conjunto de replicación.

ReplicationRole

Enumeración

Rol del servidor en un conjunto de replicación.

Valor	Description
None	No se ha asignado ningún rol de replicación; El servidor funciona de forma independiente.
Primary	Actúa como servidor de origen para la replicación en una o varias réplicas.
AsyncReplica	Recibe datos de forma asincrónica de un servidor principal dentro de la misma región.
GeoAsyncReplica	Recibe datos de forma asincrónica de un servidor principal en una región diferente para la redundancia geográfica.

ReplicationState

Enumeración

Indica el estado de replicación de una réplica de lectura. Esta propiedad solo se devuelve cuando el servidor de destino es una réplica de lectura.

Valor	Description
Active	El servidor réplica de lectura está completamente sincronizado y replica activamente los datos del servidor principal.
Catchup	El servidor réplica de lectura está detrás del servidor principal y actualmente está poniéndose al día con los cambios pendientes.
Provisioning	Se está creando un servidor de réplica de lectura y está en proceso de inicialización.
Updating	El servidor réplica de lectura está experimentando algunos cambios, puede estar cambiando el tamaño de cálculo o promoviéndolo al servidor principal.
Broken	La replicación ha fallado o se ha interrumpido.
Reconfiguring	El servidor réplica de lectura está siendo reconfigurado, posiblemente debido a cambios en la fuente o en la configuración.

Server

Objeto

Propiedades de un servidor.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	UserAssignedIdentity	Identidades administradas asignadas por el usuario asignadas al servidor.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.administratorLogin	string	Nombre del inicio de sesión designado como el primer administrador basado en contraseña asignado a su instancia de PostgreSQL. Debe especificarse la primera vez que habilite la autenticación basada en contraseña en un servidor. Una vez establecido en un valor dado, no se puede cambiar durante el resto de la vida útil de un servidor. Si deshabilita la autenticación basada en contraseña en un servidor que la tenía habilitada, este rol basado en contraseña no se elimina.
properties.administratorLoginPassword	string (password)	Contraseña asignada al inicio de sesión del administrador. Siempre que la autenticación con contraseña esté habilitada, esta contraseña se puede cambiar en cualquier momento.
properties.authConfig	AuthConfig	Propiedades de configuración de autenticación de un servidor.
properties.availabilityZone	string	Zona de disponibilidad de un servidor.
properties.backup	Backup	Propiedades de copia de seguridad de un servidor.
properties.cluster	Cluster	Propiedades de clúster de un servidor.
properties.createMode	CreateMode	Modo de creación de un nuevo servidor.
properties.dataEncryption	DataEncryption	Propiedades de cifrado de datos de un servidor.
properties.fullyQualifiedDomainName	string	Nombre de dominio completo de un servidor.
properties.highAvailability	HighAvailability	Propiedades de alta disponibilidad de un servidor.
properties.maintenanceWindow	MaintenanceWindow	Propiedades de la ventana de mantenimiento de un servidor.
properties.minorVersion	string	Versión secundaria del motor de base de datos PostgreSQL.
properties.network	Network	Propiedades de red de un servidor. Solo es necesario si desea que su servidor se integre en una red virtual proporcionada por el cliente.
properties.pointInTimeUTC	string (date-time)	Hora de creación (en formato ISO8601) de la copia de seguridad que desea restaurar en el nuevo servidor. Es necesario cuando 'createMode' es 'PointInTimeRestore', 'GeoRestore' o 'ReviveDropped'.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado asociadas con el servidor especificado.
properties.replica	Replica	Leer las propiedades de réplica de un servidor. Requerido solo en caso de que desee promocionar un servidor.
properties.replicaCapacity	integer (int32)	Número máximo de réplicas de lectura permitidas para un servidor.
properties.replicationRole	ReplicationRole	Rol del servidor en un conjunto de replicación.
properties.sourceServerResourceId	string (arm-id)	Identificador del servidor que se utilizará como origen del nuevo servidor. Obligatorio cuando 'createMode' es 'PointInTimeRestore', 'GeoRestore', 'Replica' o 'ReviveDropped'. Esta propiedad solo se devuelve cuando el servidor de destino es una réplica de lectura.
properties.state	ServerState	Posibles estados de un servidor.
properties.storage	Storage	Propiedades de almacenamiento de un servidor.
properties.version	PostgresMajorVersion	Versión principal del motor de base de datos PostgreSQL.
sku	Sku	Nivel de proceso y tamaño de un servidor.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

ServerList

Objeto

Lista de servidores.

Nombre	Tipo	Description
nextLink	string (uri)	El enlace a la siguiente página de artículos
value	Server[]	Los elementos del servidor de esta página

ServerPublicNetworkAccessState

Enumeración

Indica si el acceso a la red pública está habilitado o no.

Valor	Description
Enabled	El acceso a la red pública está habilitado. Esto permite acceder al servidor desde la Internet pública, siempre que se implemente la regla de firewall necesaria que permita el tráfico entrante que se origina en el cliente que se conecta. Esto es compatible con el uso de puntos de conexión privados para conectarse a este servidor.
Disabled	El acceso de red pública está deshabilitado. Esto significa que no se puede acceder al servidor desde la Internet pública, sino solo a través de puntos finales privados.

ServerState

Enumeración

Estado de un servidor.

Valor	Description
Ready	El servidor está en buen estado y no se somete a ninguna operación en el nivel de plano de administración o control. Esto no significa que el servidor esté completamente operativo a nivel de plano de datos.
Dropping	El servidor se está eliminando.
Disabled	El servidor está deshabilitado. Las razones típicas incluyen: el administrador deshabilita o cancela explícitamente la suscripción en la que se implementa el servidor, se ha alcanzado el límite de gasto o la factura está vencida. También puede ocurrir cuando el servidor se mueve a otro grupo de recursos o suscripción.
Starting	El motor de base de datos PostgreSQL se está reiniciando.
Stopping	Los recursos informáticos asociados con el servidor se detienen y desasignan. Si el servidor tiene habilitada la alta disponibilidad, los recursos informáticos del servidor en espera también se detienen y se desasignan.
Stopped	Los recursos informáticos asociados con el servidor se detienen y desasignan.
Updating	El servidor está experimentando algunos cambios que pueden o no afectar la disponibilidad del motor de base de datos PostgreSQL. Por ejemplo, los recursos de proceso del servidor se escalan o reducen, lo que puede provocar una falta de disponibilidad temporal del motor de base de datos. O, por ejemplo, se agrega o quita una regla de firewall, lo que no provoca ninguna falta de disponibilidad del motor de base de datos.
Restarting	El motor de base de datos PostgreSQL se está reiniciando.
Inaccessible	No se puede acceder al servidor, porque la clave proporcionada para cifrar y descifrar los datos está en estado no válido.
Provisioning	El servidor está en proceso de creación.

Sku

Objeto

Información informática de un servidor.

Nombre	Tipo	Description
name	string	Nombre por el que se conoce un tamaño de proceso determinado asignado a un servidor.
tier	SkuTier	Nivel del proceso asignado a un servidor.

SkuTier

Enumeración

Nivel del proceso asignado a un servidor.

Valor	Description
Burstable	Nivel rentable para un uso poco frecuente de la CPU, ideal para cargas de trabajo de desarrollo y prueba con bajos requisitos de rendimiento.
GeneralPurpose	Computación y memoria equilibradas para la mayoría de las cargas de trabajo, lo que ofrece un rendimiento escalable y un rendimiento de E/S.
MemoryOptimized	Alta relación memoria-núcleo para cargas de trabajo exigentes que necesitan un procesamiento rápido en memoria y una alta simultaneidad.

Storage

Objeto

Propiedades de almacenamiento de un servidor.

Nombre	Tipo	Description
autoGrow	StorageAutoGrow	Marque para habilitar o deshabilitar el crecimiento automático del tamaño de almacenamiento de un servidor cuando el espacio disponible se acerca a cero y las condiciones permiten aumentar automáticamente el tamaño de almacenamiento.
iops	integer (int32)	Número máximo de IOPS admitidas para el almacenamiento. Obligatorio cuando el tipo de almacenamiento es PremiumV2_LRS o UltraSSD_LRS.
storageSizeGB	integer (int32)	Tamaño del almacenamiento asignado a un servidor.
throughput	integer (int32)	Rendimiento máximo admitido para el almacenamiento. Obligatorio cuando el tipo de almacenamiento es PremiumV2_LRS o UltraSSD_LRS.
tier	AzureManagedDiskPerformanceTier	Nivel de almacenamiento de un servidor.
type	StorageType	Tipo de almacenamiento asignado a un servidor. Los valores permitidos son Premium_LRS, PremiumV2_LRS o UltraSSD_LRS. Si no se especifica, el valor predeterminado es Premium_LRS.

StorageAutoGrow

Enumeración

Indica si el servidor está configurado para aumentar automáticamente el tamaño del almacenamiento cuando el espacio disponible está cerca de cero y las condiciones permiten un crecimiento automático del tamaño del almacenamiento.

Valor	Description
Enabled	El servidor debe aumentar automáticamente el tamaño de almacenamiento cuando el espacio disponible se acerca a cero y las condiciones permiten aumentar automáticamente el tamaño de almacenamiento.
Disabled	El servidor no debe aumentar automáticamente el tamaño de almacenamiento cuando el espacio disponible se acerca a cero.

StorageType

Enumeración

Tipo de almacenamiento asignado a un servidor. Si no se especifica, el valor predeterminado es Premium_LRS.

Valor	Description
Premium_LRS	Almacenamiento con respaldo de disco de estado sólido (SSD) estándar que ofrece un rendimiento constante para cargas de trabajo de uso general.
PremiumV2_LRS	Almacenamiento en disco de estado sólido (SSD) de próxima generación con escalabilidad y rendimiento mejorados para cargas de trabajo empresariales exigentes.
UltraSSD_LRS	Almacenamiento en disco de estado sólido (SSD) de gama alta diseñado para IOPS extremas y aplicaciones sensibles a la latencia.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentity

Objeto

Identidades asociadas a un servidor.

Nombre	Tipo	Description
principalId	string	Identificador del objeto de la entidad de servicio asociada a la identidad administrada asignada por el usuario.
tenantId	string	Identificador del inquilino de un servidor.
type	IdentityType	Tipos de identidades asociadas a un servidor.
userAssignedIdentities	<string,  UserIdentity>	Mapa de identidades administradas asignadas por el usuario.

UserIdentity

Objeto

Identidad administrada asignada por el usuario asociada a un servidor.

Nombre	Tipo	Description
clientId	string	Identificador del cliente de la entidad de servicio asociada a la identidad administrada asignada por el usuario.
principalId	string	Identificador del objeto de la entidad de servicio asociada a la identidad administrada asignada por el usuario.