Replicas - List By Server

Referencia

Servicio:: PostgreSQL

Versión de la API:: 2022-12-01

Enumere todas las réplicas de un servidor determinado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName	path	True	string	El nombre del servidor. Patrón de Regex: `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*`
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	ServerListResult	Aceptar
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ReplicasListByServer

Solicitud de ejemplo

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

/** Samples for Replicas ListByServer. */
public final class Main {
    /*
     * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/ReplicasListByServer.json
     */
    /**
     * Sample code: ReplicasListByServer.
     *
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void replicasListByServer(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.replicas().listByServer("testrg", "sourcepgservername", 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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/75ece9197dbac70ac0ba651c53a79c1841944be2/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-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("testrg", "sourcepgservername", 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.ServerListResult = armpostgresqlflexibleservers.ServerListResult{
		// 	Value: []*armpostgresqlflexibleservers.Server{
		// 		{
		// 			Name: to.Ptr("pgtestsvc5rep"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/flexibleServers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"ElasticServer": to.Ptr("1"),
		// 			},
		// 			Properties: &armpostgresqlflexibleservers.ServerProperties{
		// 				AdministratorLogin: to.Ptr("cloudsa"),
		// 				AuthConfig: &armpostgresqlflexibleservers.AuthConfig{
		// 					ActiveDirectoryAuth: to.Ptr(armpostgresqlflexibleservers.ActiveDirectoryAuthEnumDisabled),
		// 					PasswordAuth: to.Ptr(armpostgresqlflexibleservers.PasswordAuthEnumEnabled),
		// 				},
		// 				AvailabilityZone: to.Ptr("2"),
		// 				Backup: &armpostgresqlflexibleservers.Backup{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-27T00:28:17.727Z"); return t}()),
		// 					GeoRedundantBackup: to.Ptr(armpostgresqlflexibleservers.GeoRedundantBackupEnumDisabled),
		// 				},
		// 				DataEncryption: &armpostgresqlflexibleservers.DataEncryption{
		// 					Type: to.Ptr(armpostgresqlflexibleservers.ArmServerKeyTypeSystemManaged),
		// 				},
		// 				FullyQualifiedDomainName: to.Ptr("pgtestsvc5rep.postgres.database.azure.com"),
		// 				HighAvailability: &armpostgresqlflexibleservers.HighAvailability{
		// 					Mode: to.Ptr(armpostgresqlflexibleservers.HighAvailabilityModeDisabled),
		// 					State: to.Ptr(armpostgresqlflexibleservers.ServerHAStateNotEnabled),
		// 				},
		// 				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("6"),
		// 				Network: &armpostgresqlflexibleservers.Network{
		// 					PublicNetworkAccess: to.Ptr(armpostgresqlflexibleservers.ServerPublicNetworkAccessStateEnabled),
		// 				},
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr(armpostgresqlflexibleservers.ReplicationRoleAsyncReplica),
		// 				State: to.Ptr(armpostgresqlflexibleservers.ServerStateReady),
		// 				Storage: &armpostgresqlflexibleservers.Storage{
		// 					StorageSizeGB: to.Ptr[int32](512),
		// 				},
		// 				Version: to.Ptr(armpostgresqlflexibleservers.ServerVersionTwelve),
		// 			},
		// 			SKU: &armpostgresqlflexibleservers.SKU{
		// 				Name: to.Ptr("Standard_D4s_v3"),
		// 				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

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

/**
 * This sample demonstrates how to List all the replicas for a given server.
 *
 * @summary List all the replicas for a given server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/ReplicasListByServer.json
 */
async function replicasListByServer() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "testrg";
  const serverName = "sourcepgservername";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let 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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "sku": {
        "name": "Standard_D4s_v3",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com",
        "version": "12",
        "minorVersion": "6",
        "administratorLogin": "cloudsa",
        "state": "Ready",
        "availabilityZone": "2",
        "storage": {
          "storageSizeGB": 512
        },
        "dataEncryption": {
          "type": "SystemManaged"
        },
        "authConfig": {
          "activeDirectoryAuth": "Disabled",
          "passwordAuth": "Enabled"
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00"
        },
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "AsyncReplica",
        "replicaCapacity": 0
      },
      "location": "westus",
      "tags": {
        "ElasticServer": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep",
      "name": "pgtestsvc5rep",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers"
    }
  ]
}

Definiciones

Nombre	Description
activeDirectoryAuthEnum	Si está habilitado, la autenticación de Azure Active Directory está habilitada.
ArmServerKeyType	Tipo de cifrado de datos que se va a representar si es Administrado por el sistema frente a Azure Key Vault.
AuthConfig	Propiedades de configuración de autenticación de un servidor
Backup	Propiedades de copia de seguridad de un servidor
createdByType	Tipo de identidad que creó el recurso.
CreateMode	Modo para crear un nuevo servidor postgreSQL.
DataEncryption	Propiedades de cifrado de datos de un servidor
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GeoRedundantBackupEnum	Valor que indica si Geo-Redundant copia de seguridad está habilitada en el servidor.
HighAvailability	Propiedades de alta disponibilidad de un servidor
HighAvailabilityMode	Modo de alta disponibilidad para el servidor.
IdentityType	los tipos de identidades asociadas a este recurso; actualmente restringido a "None y UserAssigned"
MaintenanceWindow	Propiedades de la ventana de mantenimiento de un servidor.
Network	Propiedades de red de un servidor.
passwordAuthEnum	Si está habilitado, la autenticación con contraseña está habilitada.
ReplicationRole	Se usa para indicar el rol del servidor en el conjunto de replicación.
Server	Representa un servidor.
ServerHAState	Estado de un servidor de alta disponibilidad que es visible para el usuario.
ServerListResult	Una lista de servidores.
ServerPublicNetworkAccessState	el acceso a la red pública está habilitado o no
ServerState	Estado de un servidor que es visible para el usuario.
ServerVersion	La versión de un servidor.
Sku	Propiedades relacionadas con la información de SKU de un servidor.
SkuTier	El nivel de la SKU determinada, por ejemplo, Ampliable.
Storage	Propiedades de almacenamiento de un servidor
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
UserAssignedIdentity	Información que describe las identidades asociadas a esta aplicación.
UserIdentity	Describe una única identidad asignada por el usuario asociada a la aplicación.

activeDirectoryAuthEnum

Si está habilitado, la autenticación de Azure Active Directory está habilitada.

Nombre	Tipo	Description
Disabled	string
Enabled	string

ArmServerKeyType

Tipo de cifrado de datos que se va a representar si es Administrado por el sistema frente a Azure Key Vault.

Nombre	Tipo	Description
AzureKeyVault	string
SystemManaged	string

AuthConfig

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

Nombre	Tipo	Valor predeterminado	Description
activeDirectoryAuth	activeDirectoryAuthEnum		Si está habilitada, la autenticación de Azure Active Directory está habilitada.
passwordAuth	passwordAuthEnum	Enabled	Si está habilitada, la autenticación con contraseña está habilitada.
tenantId	string		Id. de inquilino del servidor.

Backup

Propiedades de copia de seguridad de un servidor

Nombre	Tipo	Valor predeterminado	Description
backupRetentionDays	integer	7	Días de retención de copia de seguridad para el servidor.
earliestRestoreDate	string		La hora de punto de restauración más antigua (ISO8601 formato) para el servidor.
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	Valor que indica si Geo-Redundant copia de seguridad está habilitada en el servidor.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Modo para crear un nuevo servidor postgreSQL.

Nombre	Tipo	Description
Create	string
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string
Update	string

DataEncryption

Propiedades de cifrado de datos de un servidor

Nombre	Tipo	Description
primaryKeyURI	string	URI de la clave para el cifrado de datos para el servidor principal.
primaryUserAssignedIdentityId	string	Identificador de recurso de la identidad asignada por el usuario que se usará para el cifrado de datos para el servidor principal.
type	ArmServerKeyType	Tipo de cifrado de datos que se muestra si es Administrado por el sistema frente a Azure Key Vault.

ErrorAdditionalInfo

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

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

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GeoRedundantBackupEnum

Valor que indica si Geo-Redundant copia de seguridad está habilitada en el servidor.

Nombre	Tipo	Description
Disabled	string
Enabled	string

HighAvailability

Propiedades de alta disponibilidad de un servidor

Nombre	Tipo	Valor predeterminado	Description
mode	HighAvailabilityMode	Disabled	Modo de alta disponibilidad para el servidor.
standbyAvailabilityZone	string		información de la zona de disponibilidad del modo de espera.
state	ServerHAState		Estado de un servidor de alta disponibilidad que es visible para el usuario.

HighAvailabilityMode

Modo de alta disponibilidad para el servidor.

Nombre	Tipo	Description
Disabled	string
SameZone	string
ZoneRedundant	string

IdentityType

los tipos de identidades asociadas a este recurso; actualmente restringido a "None y UserAssigned"

Nombre	Tipo	Description
None	string
UserAssigned	string

MaintenanceWindow

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	0	día de la semana para la ventana de mantenimiento
startHour	integer	0	hora de inicio para la ventana de mantenimiento
startMinute	integer	0	minuto de inicio de la ventana de mantenimiento

Network

Propiedades de red de un servidor.

Nombre	Tipo	Description
delegatedSubnetResourceId	string	Id. de recurso de arm de subred delegada. Esto es necesario para pasar durante la creación, en caso de que el servidor se inserte en la red virtual, es decir, servidor de acceso privado. Durante la actualización, pase esto solo si queremos actualizar el valor de DNS privado zona.
privateDnsZoneArmResourceId	string	Identificador de recurso de arm de zona dns privada. Esto es necesario para pasar durante la creación, en caso de que el servidor se inserte en la red virtual, es decir, servidor de acceso privado. Durante la actualización, pase esto solo si queremos actualizar el valor de DNS privado zona.
publicNetworkAccess	ServerPublicNetworkAccessState	el acceso a la red pública está habilitado o no

passwordAuthEnum

Si está habilitado, la autenticación con contraseña está habilitada.

Nombre	Tipo	Description
Disabled	string
Enabled	string

ReplicationRole

Se usa para indicar el rol del servidor en el conjunto de replicación.

Nombre	Tipo	Description
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	string

Server

Representa un servidor.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	UserAssignedIdentity	Describe la identidad de la aplicación.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.administratorLogin	string	Nombre de inicio de sesión del administrador de un servidor. Solo se puede especificar cuando se crea el servidor (y es necesario para la creación).
properties.administratorLoginPassword	string	La contraseña de inicio de sesión del administrador (necesaria para la creación del servidor).
properties.authConfig	AuthConfig	Propiedades AuthConfig de un servidor.
properties.availabilityZone	string	información de zona de disponibilidad del servidor.
properties.backup	Backup	Propiedades de copia de seguridad de un servidor.
properties.createMode	CreateMode	Modo para crear un nuevo servidor postgreSQL.
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	La versión secundaria del servidor.
properties.network	Network	Propiedades de red de un servidor. Esta propiedad Network solo se debe pasar en caso de que desee que el servidor sea servidor de acceso privado.
properties.pointInTimeUTC	string	Hora de creación del punto de restauración (ISO8601 formato), especificando la hora desde la que se va a restaurar. Se requiere cuando "createMode" es "PointInTimeRestore" o "GeoRestore".
properties.replicaCapacity	integer	Réplicas permitidas para un servidor.
properties.replicationRole	ReplicationRole	Rol de replicación del servidor
properties.sourceServerResourceId	string	Identificador de recurso del servidor de origen desde el que se va a restaurar. Es necesario cuando "createMode" es "PointInTimeRestore" o "GeoRestore" o "Replica". Esta propiedad solo se devuelve para el servidor réplica.
properties.state	ServerState	Estado de un servidor que es visible para el usuario.
properties.storage	Storage	Propiedades de almacenamiento de un servidor.
properties.version	ServerVersion	Versión del servidor PostgreSQL.
sku	Sku	SKU (plan de tarifa) del servidor.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ServerHAState

Estado de un servidor de alta disponibilidad que es visible para el usuario.

Nombre	Tipo	Description
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string
ReplicatingData	string

ServerListResult

Una lista de servidores.

Nombre	Tipo	Description
nextLink	string	Vínculo que se usa para obtener la siguiente página de operaciones.
value	Server[]	La lista de servidores flexibles

ServerPublicNetworkAccessState

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

Nombre	Tipo	Description
Disabled	string
Enabled	string

ServerState

Estado de un servidor que es visible para el usuario.

Nombre	Tipo	Description
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

La versión de un servidor.

Nombre	Tipo	Description
11	string
12	string
13	string
14	string

Sku

Propiedades relacionadas con la información de SKU de un servidor.

Nombre	Tipo	Description
name	string	Nombre de la SKU, normalmente, nivel + familia + núcleos, por ejemplo, Standard_D4s_v3.
tier	SkuTier	El nivel de la SKU determinada, por ejemplo, Ampliable.

SkuTier

El nivel de la SKU determinada, por ejemplo, Ampliable.

Nombre	Tipo	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

Storage

Propiedades de almacenamiento de un servidor

Nombre	Tipo	Description
storageSizeGB	integer	Almacenamiento máximo permitido para un servidor.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	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	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

Información que describe las identidades asociadas a esta aplicación.

Nombre	Tipo	Description
tenantId	string	Id. de inquilino del servidor.
type	IdentityType	los tipos de identidades asociadas a este recurso; actualmente restringido a "None y UserAssigned"
userAssignedIdentities	<string, UserIdentity>	representa el mapa de identidades asignadas por el usuario.

UserIdentity

Describe una única identidad asignada por el usuario asociada a la aplicación.

Nombre	Tipo	Description
clientId	string	el identificador de cliente de la entidad de servicio que representa esta identidad.
principalId	string	el identificador de objeto de la entidad de servicio que representa esta identidad.

Compartir a través de

Replicas - List By Server

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ReplicasListByServer

Solicitud de ejemplo

Respuesta de muestra

Definiciones

activeDirectoryAuthEnum

ArmServerKeyType

AuthConfig

Backup

createdByType

CreateMode

DataEncryption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoRedundantBackupEnum

HighAvailability

HighAvailabilityMode

IdentityType

MaintenanceWindow

Network

passwordAuthEnum

ReplicationRole

Server

ServerHAState

ServerListResult

ServerPublicNetworkAccessState

ServerState

ServerVersion

Sku

SkuTier

Storage

systemData

UserAssignedIdentity

UserIdentity

Recursos adicionales