Replicas - List By Server
Répertorie tous les réplicas d’un serveur donné.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas?api-version=2024-11-01-preview
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
server
|
path | True |
string |
Nom du serveur. Modèle d’expression régulière: |
subscription
|
path | True |
string uuid |
ID de l’abonnement cible. La valeur doit être un UUID. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
D’ACCORD |
|
Other Status Codes |
Réponse d’erreur décrivant pourquoi l’opération a échoué. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | emprunter l’identité de votre compte d’utilisateur |
Exemples
ReplicasListByServer
Exemple de requête
Exemple de réponse
{
"value": [
{
"sku": {
"name": "Standard_D4s_v3",
"tier": "GeneralPurpose"
},
"properties": {
"fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com",
"version": "12",
"minorVersion": "6",
"administratorLogin": "cloudsa",
"state": "Ready",
"availabilityZone": "2",
"storage": {
"storageSizeGB": 512,
"autoGrow": "Disabled",
"tier": "P20",
"iops": 2300
},
"dataEncryption": {
"type": "SystemManaged"
},
"authConfig": {
"activeDirectoryAuth": "Disabled",
"passwordAuth": "Enabled"
},
"backup": {
"backupRetentionDays": 7,
"geoRedundantBackup": "Disabled",
"earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00"
},
"network": {
"publicNetworkAccess": "Enabled"
},
"highAvailability": {
"mode": "Disabled",
"state": "NotEnabled"
},
"maintenanceWindow": {
"customWindow": "Disabled",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0
},
"replicationRole": "AsyncReplica",
"replicaCapacity": 0,
"replica": {
"role": "AsyncReplica",
"capacity": 0,
"replicationState": "Active"
}
},
"location": "westus",
"tags": {
"ElasticServer": "1"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep",
"name": "pgtestsvc5rep",
"type": "Microsoft.DBforPostgreSQL/flexibleServers"
}
]
}
Définitions
Nom | Description |
---|---|
active |
Si cette option est activée, l’authentification Azure Active Directory est activée. |
Arm |
Type de chiffrement de données à représenter s’il s’agit d’un coffre de clés Géré par le système et Azure Key Vault. |
Auth |
Propriétés de configuration d’authentification d’un serveur |
Azure |
Nom du niveau de stockage pour les IOPS. |
Backup |
Propriétés de sauvegarde d’un serveur |
Cluster |
Propriétés du cluster d’un serveur. |
created |
Type d’identité qui a créé la ressource. |
Create |
Mode de création d’un serveur PostgreSQL. |
Data |
Propriétés de chiffrement des données d’un serveur |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Geo |
Valeur indiquant si Geo-Redundant sauvegarde est activée sur le serveur. |
High |
Propriétés de haute disponibilité d’un serveur |
High |
Mode haute disponibilité du serveur. |
Identity |
types d’identités associés à cette ressource |
key |
État de clé de chiffrement primaire pour le serveur avec chiffrement des données. |
Maintenance |
Propriétés de la fenêtre de maintenance d’un serveur. |
Network |
Propriétés réseau d’un serveur. |
password |
Si cette option est activée, l’authentification par mot de passe est activée. |
Private |
Ressource de point de terminaison privé. |
Private |
Ressource de connexion de point de terminaison privé. |
Private |
État d’approvisionnement actuel. |
Private |
État de la connexion de point de terminaison privé. |
Private |
Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. |
Read |
Définit le mode de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule. |
Replica |
Propriétés du réplica d’un serveur |
Replication |
Définit les options de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule. |
Replication |
Utilisé pour indiquer le rôle du serveur dans le jeu de réplication. |
Replication |
Obtient l’état de réplication d’un serveur réplica. Cette propriété est retournée uniquement pour l’appel d’API réplicas. Les valeurs prises en charge sont Active, Catchup, Provisioning, Mise à jour, Broken, Reconfiguring |
Server |
Représente un serveur. |
Server |
État d’un serveur haute disponibilité visible par l’utilisateur. |
Server |
Liste des serveurs. |
Server |
l’accès au réseau public est activé ou non |
Server |
État d’un serveur visible par l’utilisateur. |
Server |
Version d’un serveur. |
Sku |
Propriétés associées aux informations de référence SKU d’un serveur. |
Sku |
Niveau de la référence SKU particulière, par exemple Burstable. |
Storage |
Propriétés de stockage d’un serveur |
Storage |
Indicateur permettant d’activer/désactiver la croissance automatique du stockage pour un serveur flexible. |
Storage |
Type de stockage pour le serveur. Les valeurs autorisées sont Premium_LRS, PremiumV2_LRS et UltraSSD_LRS. La valeur par défaut est Premium_LRS si elle n’est pas spécifiée |
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
User |
Informations décrivant les identités associées à cette application. |
User |
Décrit une identité affectée par l’utilisateur unique associée à l’application. |
activeDirectoryAuthEnum
Si cette option est activée, l’authentification Azure Active Directory est activée.
Nom | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ArmServerKeyType
Type de chiffrement de données à représenter s’il s’agit d’un coffre de clés Géré par le système et Azure Key Vault.
Nom | Type | Description |
---|---|---|
AzureKeyVault |
string |
|
SystemManaged |
string |
AuthConfig
Propriétés de configuration d’authentification d’un serveur
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
activeDirectoryAuth |
Si cette option est activée, l’authentification Azure Active Directory est activée. |
||
passwordAuth | Enabled |
Si cette option est activée, l’authentification par mot de passe est activée. |
|
tenantId |
string |
ID de locataire du serveur. |
AzureManagedDiskPerformanceTiers
Nom du niveau de stockage pour les IOPS.
Nom | Type | Description |
---|---|---|
P1 |
string |
|
P10 |
string |
|
P15 |
string |
|
P2 |
string |
|
P20 |
string |
|
P3 |
string |
|
P30 |
string |
|
P4 |
string |
|
P40 |
string |
|
P50 |
string |
|
P6 |
string |
|
P60 |
string |
|
P70 |
string |
|
P80 |
string |
Backup
Propriétés de sauvegarde d’un serveur
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
backupRetentionDays |
integer |
7 |
Jours de rétention de sauvegarde pour le serveur. |
earliestRestoreDate |
string |
Heure de point de restauration la plus ancienne (format ISO8601) pour le serveur. |
|
geoRedundantBackup | Disabled |
Valeur indiquant si Geo-Redundant sauvegarde est activée sur le serveur. |
Cluster
Propriétés du cluster d’un serveur.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
clusterSize |
integer |
0 |
Nombre de nœuds pour le cluster. |
createdByType
Type d’identité qui a créé la ressource.
Nom | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
Mode de création d’un serveur PostgreSQL.
Nom | Type | Description |
---|---|---|
Create |
string |
|
Default |
string |
|
GeoRestore |
string |
|
PointInTimeRestore |
string |
|
Replica |
string |
|
ReviveDropped |
string |
|
Update |
string |
DataEncryption
Propriétés de chiffrement des données d’un serveur
Nom | Type | Description |
---|---|---|
geoBackupEncryptionKeyStatus |
État de la clé de chiffrement de géo-sauvegarde pour le serveur avec chiffrement des données. |
|
geoBackupKeyURI |
string |
URI de la clé dans keyvault pour le chiffrement des données pour la géo-sauvegarde du serveur. |
geoBackupUserAssignedIdentityId |
string |
ID de ressource de l’identité affectée par l’utilisateur à utiliser pour le chiffrement des données pour la géo-sauvegarde du serveur. |
primaryEncryptionKeyStatus |
État de clé de chiffrement primaire pour le serveur avec chiffrement des données. |
|
primaryKeyURI |
string |
URI de la clé dans keyvault pour le chiffrement des données du serveur principal. |
primaryUserAssignedIdentityId |
string |
ID de ressource de l’identité affectée par l’utilisateur à utiliser pour le chiffrement des données du serveur principal. |
type |
Type de chiffrement de données à représenter s’il s’agit d’un coffre de clés Géré par le système et Azure Key Vault. |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires. |
type |
string |
Type d’informations supplémentaire. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d’erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |
GeoRedundantBackupEnum
Valeur indiquant si Geo-Redundant sauvegarde est activée sur le serveur.
Nom | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
HighAvailability
Propriétés de haute disponibilité d’un serveur
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
mode | Disabled |
Mode haute disponibilité du serveur. |
|
standbyAvailabilityZone |
string |
informations sur la zone de disponibilité du serveur de secours. |
|
state |
État d’un serveur haute disponibilité visible par l’utilisateur. |
HighAvailabilityMode
Mode haute disponibilité du serveur.
Nom | Type | Description |
---|---|---|
Disabled |
string |
|
SameZone |
string |
|
ZoneRedundant |
string |
IdentityType
types d’identités associés à cette ressource
Nom | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
UserAssigned |
string |
keyStatusEnum
État de clé de chiffrement primaire pour le serveur avec chiffrement des données.
Nom | Type | Description |
---|---|---|
Invalid |
string |
|
Valid |
string |
MaintenanceWindow
Propriétés de la fenêtre de maintenance d’un serveur.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
customWindow |
string |
Disabled |
indique si la fenêtre personnalisée est activée ou désactivée |
dayOfWeek |
integer |
0 |
jour de semaine pour la fenêtre de maintenance |
startHour |
integer |
0 |
heure de début de la fenêtre de maintenance |
startMinute |
integer |
0 |
minute de démarrage de la fenêtre de maintenance |
Network
Propriétés réseau d’un serveur.
Nom | Type | Description |
---|---|---|
delegatedSubnetResourceId |
string |
ID de ressource du sous-réseau délégué. Cette opération doit être transmise pendant la création, au cas où nous voulons que le serveur soit injecté au réseau virtuel, c’est-à-dire un serveur d’accès privé. Pendant la mise à jour, transmettez-la uniquement si nous voulons mettre à jour la valeur de la zone DNS privée. |
privateDnsZoneArmResourceId |
string |
ID de ressource arm de zone DNS privée. Cette opération doit être transmise pendant la création, au cas où nous voulons que le serveur soit injecté au réseau virtuel, c’est-à-dire un serveur d’accès privé. Pendant la mise à jour, transmettez-la uniquement si nous voulons mettre à jour la valeur de la zone DNS privée. |
publicNetworkAccess |
l’accès au réseau public est activé ou non |
passwordAuthEnum
Si cette option est activée, l’authentification par mot de passe est activée.
Nom | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
PrivateEndpoint
Ressource de point de terminaison privé.
Nom | Type | Description |
---|---|---|
id |
string |
Identificateur ARM pour le point de terminaison privé. |
PrivateEndpointConnection
Ressource de connexion de point de terminaison privé.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} » |
name |
string |
Nom de la ressource |
properties.groupIds |
string[] |
ID de groupe pour la ressource de point de terminaison privé. |
properties.privateEndpoint |
Ressource de point de terminaison privé. |
|
properties.privateLinkServiceConnectionState |
Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. |
|
properties.provisioningState |
État d’approvisionnement de la ressource de connexion de point de terminaison privé. |
|
systemData |
Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. |
|
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
PrivateEndpointConnectionProvisioningState
État d’approvisionnement actuel.
Nom | Type | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
État de la connexion de point de terminaison privé.
Nom | Type | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
Nom | Type | Description |
---|---|---|
actionsRequired |
string |
Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. |
description |
string |
Raison de l’approbation/rejet de la connexion. |
status |
Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service. |
ReadReplicaPromoteMode
Définit le mode de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule.
Nom | Type | Description |
---|---|---|
standalone |
string |
|
switchover |
string |
Replica
Propriétés du réplica d’un serveur
Nom | Type | Description |
---|---|---|
capacity |
integer |
Réplicas autorisés pour un serveur. |
promoteMode |
Définit le mode de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule. |
|
promoteOption |
Définit les options de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule. |
|
replicationState |
Obtient l’état de réplication d’un serveur réplica. Cette propriété est retournée uniquement pour l’appel d’API réplicas. Les valeurs prises en charge sont Active, Catchup, Provisioning, Mise à jour, Broken, Reconfiguring |
|
role |
Utilisé pour indiquer le rôle du serveur dans le jeu de réplication. |
ReplicationPromoteOption
Définit les options de promotion d’un serveur réplica. Il s’agit d’une propriété en écriture seule.
Nom | Type | Description |
---|---|---|
forced |
string |
|
planned |
string |
ReplicationRole
Utilisé pour indiquer le rôle du serveur dans le jeu de réplication.
Nom | Type | Description |
---|---|---|
AsyncReplica |
string |
|
GeoAsyncReplica |
string |
|
None |
string |
|
Primary |
string |
ReplicationState
Obtient l’état de réplication d’un serveur réplica. Cette propriété est retournée uniquement pour l’appel d’API réplicas. Les valeurs prises en charge sont Active, Catchup, Provisioning, Mise à jour, Broken, Reconfiguring
Nom | Type | Description |
---|---|---|
Active |
string |
|
Broken |
string |
|
Catchup |
string |
|
Provisioning |
string |
|
Reconfiguring |
string |
|
Updating |
string |
Server
Représente un serveur.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} » |
identity |
Décrit l’identité de l’application. |
|
location |
string |
Emplacement géographique où réside la ressource |
name |
string |
Nom de la ressource |
properties.administratorLogin |
string |
Nom de connexion de l’administrateur d’un serveur. Ne peut être spécifié que lorsque le serveur est en cours de création (et est requis pour la création). |
properties.administratorLoginPassword |
string |
Mot de passe de connexion administrateur (requis pour la création du serveur). |
properties.authConfig |
Propriétés AuthConfig d’un serveur. |
|
properties.availabilityZone |
string |
informations sur la zone de disponibilité du serveur. |
properties.backup |
Propriétés de sauvegarde d’un serveur. |
|
properties.cluster |
Propriétés du cluster d’un serveur. |
|
properties.createMode |
Mode de création d’un serveur PostgreSQL. |
|
properties.dataEncryption |
Propriétés de chiffrement des données d’un serveur. |
|
properties.fullyQualifiedDomainName |
string |
Nom de domaine complet d’un serveur. |
properties.highAvailability |
Propriétés de haute disponibilité d’un serveur. |
|
properties.maintenanceWindow |
Propriétés de la fenêtre de maintenance d’un serveur. |
|
properties.minorVersion |
string |
Version mineure du serveur. |
properties.network |
Propriétés réseau d’un serveur. Cette propriété réseau doit être transmise uniquement si vous souhaitez que le serveur soit un serveur d’accès privé. |
|
properties.pointInTimeUTC |
string |
Heure de création du point de restauration (format ISO8601), en spécifiant l’heure de restauration à partir de laquelle effectuer la restauration. Il est nécessaire lorsque « createMode » est « PointInTimeRestore » ou « GeoRestore » ou « ReviveDropped ». |
properties.privateEndpointConnections |
Liste des connexions de point de terminaison privé associées à la ressource spécifiée. |
|
properties.replica |
Propriétés du réplica d’un serveur. Ces propriétés de réplica doivent être transmises uniquement si vous souhaitez promouvoir un serveur. |
|
properties.replicaCapacity |
integer |
Réplicas autorisés pour un serveur. |
properties.replicationRole |
Rôle de réplication du serveur |
|
properties.sourceServerResourceId |
string |
ID de ressource du serveur source à partir duquel effectuer la restauration. Il est nécessaire lorsque « createMode » est « PointInTimeRestore » ou « GeoRestore » ou « Replica » ou « ReviveDropped ». Cette propriété est retournée uniquement pour le serveur réplica |
properties.state |
État d’un serveur visible par l’utilisateur. |
|
properties.storage |
Propriétés de stockage d’un serveur. |
|
properties.version |
Version du serveur PostgreSQL. |
|
sku |
Référence SKU (niveau tarifaire) du serveur. |
|
systemData |
Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. |
|
tags |
object |
Balises de ressource. |
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
ServerHAState
État d’un serveur haute disponibilité visible par l’utilisateur.
Nom | Type | Description |
---|---|---|
CreatingStandby |
string |
|
FailingOver |
string |
|
Healthy |
string |
|
NotEnabled |
string |
|
RemovingStandby |
string |
|
ReplicatingData |
string |
ServerListResult
Liste des serveurs.
Nom | Type | Description |
---|---|---|
nextLink |
string |
Lien utilisé pour obtenir la page suivante des opérations. |
value |
Server[] |
Liste des serveurs flexibles |
ServerPublicNetworkAccessState
l’accès au réseau public est activé ou non
Nom | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ServerState
État d’un serveur visible par l’utilisateur.
Nom | Type | Description |
---|---|---|
Disabled |
string |
|
Dropping |
string |
|
Ready |
string |
|
Starting |
string |
|
Stopped |
string |
|
Stopping |
string |
|
Updating |
string |
ServerVersion
Version d’un serveur.
Nom | Type | Description |
---|---|---|
11 |
string |
|
12 |
string |
|
13 |
string |
|
14 |
string |
|
15 |
string |
|
16 |
string |
|
17 |
string |
Sku
Propriétés associées aux informations de référence SKU d’un serveur.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de la référence SKU, généralement, niveau + famille + cœurs, par exemple Standard_D4s_v3. |
tier |
Niveau de la référence SKU particulière, par exemple Burstable. |
SkuTier
Niveau de la référence SKU particulière, par exemple Burstable.
Nom | Type | Description |
---|---|---|
Burstable |
string |
|
GeneralPurpose |
string |
|
MemoryOptimized |
string |
Storage
Propriétés de stockage d’un serveur
Nom | Type | Description |
---|---|---|
autoGrow |
Indicateur permettant d’activer/désactiver la croissance automatique du stockage pour un serveur flexible. |
|
iops |
integer |
Quantité d’IOPS du niveau de stockage. Cette propriété doit être définie pour le type de stockage PremiumV2_LRS et UltraSSD_LRS. |
storageSizeGB |
integer |
Stockage maximal autorisé pour un serveur. |
throughput |
integer |
Débit de stockage pour le serveur. Cette opération doit être définie pour le type de stockage PremiumV2_LRS et les UltraSSD_LRS. |
tier |
Nom du niveau de stockage pour les IOPS. |
|
type |
Type de stockage pour le serveur. Les valeurs autorisées sont Premium_LRS, PremiumV2_LRS et UltraSSD_LRS. La valeur par défaut est Premium_LRS si elle n’est pas spécifiée |
StorageAutoGrow
Indicateur permettant d’activer/désactiver la croissance automatique du stockage pour un serveur flexible.
Nom | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
StorageType
Type de stockage pour le serveur. Les valeurs autorisées sont Premium_LRS, PremiumV2_LRS et UltraSSD_LRS. La valeur par défaut est Premium_LRS si elle n’est pas spécifiée
Nom | Type | Description |
---|---|---|
PremiumV2_LRS |
string |
|
Premium_LRS |
string |
|
UltraSSD_LRS |
string |
systemData
Métadonnées relatives à la création et à la dernière modification de la ressource.
Nom | Type | Description |
---|---|---|
createdAt |
string |
Horodatage de la création de ressources (UTC). |
createdBy |
string |
Identité qui a créé la ressource. |
createdByType |
Type d’identité qui a créé la ressource. |
|
lastModifiedAt |
string |
Horodatage de la dernière modification de ressource (UTC) |
lastModifiedBy |
string |
Identité qui a modifié la ressource pour la dernière fois. |
lastModifiedByType |
Type d’identité qui a modifié la ressource pour la dernière fois. |
UserAssignedIdentity
Informations décrivant les identités associées à cette application.
Nom | Type | Description |
---|---|---|
tenantId |
string |
ID de locataire du serveur. |
type |
types d’identités associés à cette ressource |
|
userAssignedIdentities |
<string,
User |
représente la carte des identités affectées par l’utilisateur. |
UserIdentity
Décrit une identité affectée par l’utilisateur unique associée à l’application.
Nom | Type | Description |
---|---|---|
clientId |
string |
identificateur client du principal de service que cette identité représente. |
principalId |
string |
identificateur d’objet du principal de service que cette identité représente. |