Replicas - List By Server
Geef alle replica's voor een bepaalde server weer.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas?api-version=2024-11-01-preview
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
server
|
path | True |
string |
De naam van de server. Regex-patroon: |
subscription
|
path | True |
string uuid |
De id van het doelabonnement. De waarde moet een UUID zijn. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
ReplicasListByServer
Voorbeeldaanvraag
Voorbeeldrespons
{
"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"
}
]
}
Definities
Name | Description |
---|---|
active |
Als deze optie is ingeschakeld, is Azure Active Directory-verificatie ingeschakeld. |
Arm |
Gegevensversleutelingstype om aan te geven of het systeem beheerd is versus Azure Key Vault. |
Auth |
Eigenschappen van verificatieconfiguratie van een server |
Azure |
Naam van opslaglaag voor IOPS. |
Backup |
Back-upeigenschappen van een server |
Cluster |
Clustereigenschappen van een server. |
created |
Het type identiteit waarmee de resource is gemaakt. |
Create |
De modus voor het maken van een nieuwe PostgreSQL-server. |
Data |
Eigenschappen van gegevensversleuteling van een server |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Geo |
Een waarde die aangeeft of Geo-Redundant back-up is ingeschakeld op de server. |
High |
Eigenschappen van hoge beschikbaarheid van een server |
High |
De ha-modus voor de server. |
Identity |
de typen identiteiten die zijn gekoppeld aan deze resource |
key |
Status van primaire versleutelingssleutel voor server met gegevensversleuteling. |
Maintenance |
Eigenschappen van een onderhoudsvenster van een server. |
Network |
Netwerkeigenschappen van een server. |
password |
Als deze optie is ingeschakeld, is wachtwoordverificatie ingeschakeld. |
Private |
De privé-eindpuntresource. |
Private |
De privé-eindpuntverbindingsresource. |
Private |
De huidige inrichtingsstatus. |
Private |
De verbindingsstatus van het privé-eindpunt. |
Private |
Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider. |
Read |
Hiermee stelt u de promotiemodus voor een replicaserver in. Dit is een eigenschap voor alleen schrijven. |
Replica |
Replica-eigenschappen van een server |
Replication |
Hiermee stelt u de promotieopties voor een replicaserver in. Dit is een eigenschap voor alleen schrijven. |
Replication |
Wordt gebruikt om de rol van de server in de replicatieset aan te geven. |
Replication |
Hiermee haalt u de replicatiestatus van een replicaserver op. Deze eigenschap wordt alleen geretourneerd voor de api-aanroep van replica's. Ondersteunde waarden zijn Actief, Catchup, Inrichten, Bijwerken, Verbroken, Opnieuw configureren |
Server |
Vertegenwoordigt een server. |
Server |
Een status van een HA-server die zichtbaar is voor de gebruiker. |
Server |
Een lijst met servers. |
Server |
openbare netwerktoegang is ingeschakeld of niet |
Server |
Een status van een server die zichtbaar is voor de gebruiker. |
Server |
De versie van een server. |
Sku |
SKU-informatie gerelateerde eigenschappen van een server. |
Sku |
De laag van de specifieke SKU, bijvoorbeeld Burstable. |
Storage |
Opslageigenschappen van een server |
Storage |
Vlag voor het in- of uitschakelen van automatisch vergroten van opslag voor flexibele server. |
Storage |
Opslagtype voor de server. Toegestane waarden zijn Premium_LRS, PremiumV2_LRS en UltraSSD_LRS. De standaardwaarde is Premium_LRS als deze niet is opgegeven |
system |
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource. |
User |
Informatie over de identiteiten die aan deze toepassing zijn gekoppeld. |
User |
Beschrijft één door de gebruiker toegewezen identiteit die is gekoppeld aan de toepassing. |
activeDirectoryAuthEnum
Als deze optie is ingeschakeld, is Azure Active Directory-verificatie ingeschakeld.
Waarde | Description |
---|---|
Disabled | |
Enabled |
ArmServerKeyType
Gegevensversleutelingstype om aan te geven of het systeem beheerd is versus Azure Key Vault.
Waarde | Description |
---|---|
AzureKeyVault | |
SystemManaged |
AuthConfig
Eigenschappen van verificatieconfiguratie van een server
Name | Type | Default value | Description |
---|---|---|---|
activeDirectoryAuth |
Als deze optie is ingeschakeld, is Azure Active Directory-verificatie ingeschakeld. |
||
passwordAuth | Enabled |
Als deze optie is ingeschakeld, is wachtwoordverificatie ingeschakeld. |
|
tenantId |
string |
Tenant-id van de server. |
AzureManagedDiskPerformanceTiers
Naam van opslaglaag voor IOPS.
Waarde | Description |
---|---|
P1 | |
P10 | |
P15 | |
P2 | |
P20 | |
P3 | |
P30 | |
P4 | |
P40 | |
P50 | |
P6 | |
P60 | |
P70 | |
P80 |
Backup
Back-upeigenschappen van een server
Name | Type | Default value | Description |
---|---|---|---|
backupRetentionDays |
integer |
7 |
Bewaardagen voor back-ups voor de server. |
earliestRestoreDate |
string |
De vroegste herstelpunttijd (ISO8601-indeling) voor de server. |
|
geoRedundantBackup | Disabled |
Een waarde die aangeeft of Geo-Redundant back-up is ingeschakeld op de server. |
Cluster
Clustereigenschappen van een server.
Name | Type | Default value | Description |
---|---|---|---|
clusterSize |
integer |
0 |
Het aantal knooppunten voor het cluster. |
createdByType
Het type identiteit waarmee de resource is gemaakt.
Waarde | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
CreateMode
De modus voor het maken van een nieuwe PostgreSQL-server.
Waarde | Description |
---|---|
Create | |
Default | |
GeoRestore | |
PointInTimeRestore | |
Replica | |
ReviveDropped | |
Update |
DataEncryption
Eigenschappen van gegevensversleuteling van een server
Name | Type | Description |
---|---|---|
geoBackupEncryptionKeyStatus |
Status van versleutelingssleutel voor geo-back-up voor server met gegevensversleuteling. |
|
geoBackupKeyURI |
string |
URI voor de sleutel in keyvault voor gegevensversleuteling voor geo-back-up van de server. |
geoBackupUserAssignedIdentityId |
string |
Resource-id voor de door de gebruiker toegewezen identiteit die moet worden gebruikt voor gegevensversleuteling voor geo-back-up van de server. |
primaryEncryptionKeyStatus |
Status van primaire versleutelingssleutel voor server met gegevensversleuteling. |
|
primaryKeyURI |
string |
URI voor de sleutel in keyvault voor gegevensversleuteling van de primaire server. |
primaryUserAssignedIdentityId |
string |
Resource-id voor de door de gebruiker toegewezen identiteit die moet worden gebruikt voor gegevensversleuteling van de primaire server. |
type |
Gegevensversleutelingstype om aan te geven of het systeem beheerd is versus Azure Key Vault. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het extra informatietype. |
ErrorDetail
De foutdetails.
Name | Type | Description |
---|---|---|
additionalInfo |
De fout bevat aanvullende informatie. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
GeoRedundantBackupEnum
Een waarde die aangeeft of Geo-Redundant back-up is ingeschakeld op de server.
Waarde | Description |
---|---|
Disabled | |
Enabled |
HighAvailability
Eigenschappen van hoge beschikbaarheid van een server
Name | Type | Default value | Description |
---|---|---|---|
mode | Disabled |
De ha-modus voor de server. |
|
standbyAvailabilityZone |
string |
informatie over de beschikbaarheidszone van de stand-by. |
|
state |
Een status van een HA-server die zichtbaar is voor de gebruiker. |
HighAvailabilityMode
De ha-modus voor de server.
Waarde | Description |
---|---|
Disabled | |
SameZone | |
ZoneRedundant |
IdentityType
de typen identiteiten die zijn gekoppeld aan deze resource
Waarde | Description |
---|---|
None | |
SystemAssigned | |
SystemAssigned,UserAssigned | |
UserAssigned |
keyStatusEnum
Status van primaire versleutelingssleutel voor server met gegevensversleuteling.
Waarde | Description |
---|---|
Invalid | |
Valid |
MaintenanceWindow
Eigenschappen van een onderhoudsvenster van een server.
Name | Type | Default value | Description |
---|---|---|---|
customWindow |
string |
Disabled |
geeft aan of aangepast venster is ingeschakeld of uitgeschakeld |
dayOfWeek |
integer |
0 |
dag van de week voor onderhoudsvenster |
startHour |
integer |
0 |
beginuur voor onderhoudsvenster |
startMinute |
integer |
0 |
beginminut voor onderhoudsvenster |
Network
Netwerkeigenschappen van een server.
Name | Type | Description |
---|---|---|
delegatedSubnetResourceId |
string |
Gedelegeerde resource-id van subnetarm. Dit moet worden doorgegeven tijdens het maken, voor het geval we willen dat de server wordt geïnjecteerd in VNET, bijvoorbeeld privétoegangsserver. Geef dit tijdens de update alleen door als we de waarde voor de privé-DNS-zone willen bijwerken. |
privateDnsZoneArmResourceId |
string |
Privé-DNS-zone arm-resource-id. Dit moet worden doorgegeven tijdens het maken, voor het geval we willen dat de server wordt geïnjecteerd in VNET, bijvoorbeeld privétoegangsserver. Geef dit tijdens de update alleen door als we de waarde voor de privé-DNS-zone willen bijwerken. |
publicNetworkAccess |
openbare netwerktoegang is ingeschakeld of niet |
passwordAuthEnum
Als deze optie is ingeschakeld, is wachtwoordverificatie ingeschakeld.
Waarde | Description |
---|---|
Disabled | |
Enabled |
PrivateEndpoint
De privé-eindpuntresource.
Name | Type | Description |
---|---|---|
id |
string |
De ARM-id voor privé-eindpunt. |
PrivateEndpointConnection
De privé-eindpuntverbindingsresource.
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}" |
name |
string |
De naam van de resource |
properties.groupIds |
string[] |
De groeps-id's voor de privé-eindpuntresource. |
properties.privateEndpoint |
De privé-eindpuntresource. |
|
properties.privateLinkServiceConnectionState |
Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider. |
|
properties.provisioningState |
De inrichtingsstatus van de privé-eindpuntverbindingsresource. |
|
systemData |
Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens. |
|
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
PrivateEndpointConnectionProvisioningState
De huidige inrichtingsstatus.
Waarde | Description |
---|---|
Creating | |
Deleting | |
Failed | |
Succeeded |
PrivateEndpointServiceConnectionStatus
De verbindingsstatus van het privé-eindpunt.
Waarde | Description |
---|---|
Approved | |
Pending | |
Rejected |
PrivateLinkServiceConnectionState
Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen. |
description |
string |
De reden voor goedkeuring/afwijzing van de verbinding. |
status |
Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service. |
ReadReplicaPromoteMode
Hiermee stelt u de promotiemodus voor een replicaserver in. Dit is een eigenschap voor alleen schrijven.
Waarde | Description |
---|---|
standalone | |
switchover |
Replica
Replica-eigenschappen van een server
Name | Type | Description |
---|---|---|
capacity |
integer |
Replica's die zijn toegestaan voor een server. |
promoteMode |
Hiermee stelt u de promotiemodus voor een replicaserver in. Dit is een eigenschap voor alleen schrijven. |
|
promoteOption |
Hiermee stelt u de promotieopties voor een replicaserver in. Dit is een eigenschap voor alleen schrijven. |
|
replicationState |
Hiermee haalt u de replicatiestatus van een replicaserver op. Deze eigenschap wordt alleen geretourneerd voor de api-aanroep van replica's. Ondersteunde waarden zijn Actief, Catchup, Inrichten, Bijwerken, Verbroken, Opnieuw configureren |
|
role |
Wordt gebruikt om de rol van de server in de replicatieset aan te geven. |
ReplicationPromoteOption
Hiermee stelt u de promotieopties voor een replicaserver in. Dit is een eigenschap voor alleen schrijven.
Waarde | Description |
---|---|
forced | |
planned |
ReplicationRole
Wordt gebruikt om de rol van de server in de replicatieset aan te geven.
Waarde | Description |
---|---|
AsyncReplica | |
GeoAsyncReplica | |
None | |
Primary |
ReplicationState
Hiermee haalt u de replicatiestatus van een replicaserver op. Deze eigenschap wordt alleen geretourneerd voor de api-aanroep van replica's. Ondersteunde waarden zijn Actief, Catchup, Inrichten, Bijwerken, Verbroken, Opnieuw configureren
Waarde | Description |
---|---|
Active | |
Broken | |
Catchup | |
Provisioning | |
Reconfiguring | |
Updating |
Server
Vertegenwoordigt een server.
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}" |
identity |
Beschrijft de identiteit van de toepassing. |
|
location |
string |
De geografische locatie waar de resource zich bevindt |
name |
string |
De naam van de resource |
properties.administratorLogin |
string |
De aanmeldingsnaam van de beheerder van een server. Kan alleen worden opgegeven wanneer de server wordt gemaakt (en is vereist voor het maken). |
properties.administratorLoginPassword |
string |
Het aanmeldingswachtwoord van de beheerder (vereist voor het maken van de server). |
properties.authConfig |
AuthConfig-eigenschappen van een server. |
|
properties.availabilityZone |
string |
informatie over de beschikbaarheidszone van de server. |
properties.backup |
Back-upeigenschappen van een server. |
|
properties.cluster |
Clustereigenschappen van een server. |
|
properties.createMode |
De modus voor het maken van een nieuwe PostgreSQL-server. |
|
properties.dataEncryption |
Eigenschappen van gegevensversleuteling van een server. |
|
properties.fullyQualifiedDomainName |
string |
De volledig gekwalificeerde domeinnaam van een server. |
properties.highAvailability |
Eigenschappen van hoge beschikbaarheid van een server. |
|
properties.maintenanceWindow |
Eigenschappen van een onderhoudsvenster van een server. |
|
properties.minorVersion |
string |
De secundaire versie van de server. |
properties.network |
Netwerkeigenschappen van een server. Deze netwerkeigenschap moet alleen worden doorgegeven als u wilt dat de server privétoegangsserver is. |
|
properties.pointInTimeUTC |
string |
Tijd voor het maken van herstelpunten (ISO8601-indeling), waarin de tijd wordt opgegeven waaruit u wilt herstellen. Dit is vereist wanneer createMode 'PointInTimeRestore' of 'GeoRestore' of 'ReviveDropped' is. |
properties.privateEndpointConnections |
Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan de opgegeven resource. |
|
properties.replica |
Replica-eigenschappen van een server. Deze replica-eigenschappen moeten alleen worden doorgegeven voor het geval u een server wilt promoveren. |
|
properties.replicaCapacity |
integer |
Replica's die zijn toegestaan voor een server. |
properties.replicationRole |
Replicatiefunctie van de server |
|
properties.sourceServerResourceId |
string |
De bronserverresource-id waaruit u wilt herstellen. Dit is vereist wanneer 'createMode' 'PointInTimeRestore' of 'GeoRestore' of 'Replica' of 'ReviveDropped' is. Deze eigenschap wordt alleen geretourneerd voor de replicaserver |
properties.state |
Een status van een server die zichtbaar is voor de gebruiker. |
|
properties.storage |
Opslageigenschappen van een server. |
|
properties.version |
PostgreSQL Server-versie. |
|
sku |
De SKU (prijscategorie) van de server. |
|
systemData |
Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens. |
|
tags |
object |
Resourcetags. |
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
ServerHAState
Een status van een HA-server die zichtbaar is voor de gebruiker.
Waarde | Description |
---|---|
CreatingStandby | |
FailingOver | |
Healthy | |
NotEnabled | |
RemovingStandby | |
ReplicatingData |
ServerListResult
Een lijst met servers.
Name | Type | Description |
---|---|---|
nextLink |
string |
De koppeling wordt gebruikt om de volgende pagina met bewerkingen op te halen. |
value |
Server[] |
De lijst met flexibele servers |
ServerPublicNetworkAccessState
openbare netwerktoegang is ingeschakeld of niet
Waarde | Description |
---|---|
Disabled | |
Enabled |
ServerState
Een status van een server die zichtbaar is voor de gebruiker.
Waarde | Description |
---|---|
Disabled | |
Dropping | |
Ready | |
Starting | |
Stopped | |
Stopping | |
Updating |
ServerVersion
De versie van een server.
Waarde | Description |
---|---|
11 | |
12 | |
13 | |
14 | |
15 | |
16 | |
17 |
Sku
SKU-informatie gerelateerde eigenschappen van een server.
Name | Type | Description |
---|---|---|
name |
string |
De naam van de SKU, meestal laag + familie + kernen, bijvoorbeeld Standard_D4s_v3. |
tier |
De laag van de specifieke SKU, bijvoorbeeld Burstable. |
SkuTier
De laag van de specifieke SKU, bijvoorbeeld Burstable.
Waarde | Description |
---|---|
Burstable | |
GeneralPurpose | |
MemoryOptimized |
Storage
Opslageigenschappen van een server
Name | Type | Description |
---|---|---|
autoGrow |
Vlag voor het in- of uitschakelen van automatisch vergroten van opslag voor flexibele server. |
|
iops |
integer |
IOPS-hoeveelheid voor opslaglaag. Deze eigenschap moet worden ingesteld voor opslagtype PremiumV2_LRS en UltraSSD_LRS. |
storageSizeGB |
integer |
Maximale opslag die is toegestaan voor een server. |
throughput |
integer |
Opslagdoorvoer voor de server. Dit moet worden ingesteld voor opslagtype PremiumV2_LRS en UltraSSD_LRS. |
tier |
Naam van opslaglaag voor IOPS. |
|
type |
Opslagtype voor de server. Toegestane waarden zijn Premium_LRS, PremiumV2_LRS en UltraSSD_LRS. De standaardwaarde is Premium_LRS als deze niet is opgegeven |
StorageAutoGrow
Vlag voor het in- of uitschakelen van automatisch vergroten van opslag voor flexibele server.
Waarde | Description |
---|---|
Disabled | |
Enabled |
StorageType
Opslagtype voor de server. Toegestane waarden zijn Premium_LRS, PremiumV2_LRS en UltraSSD_LRS. De standaardwaarde is Premium_LRS als deze niet is opgegeven
Waarde | Description |
---|---|
PremiumV2_LRS | |
Premium_LRS | |
UltraSSD_LRS |
systemData
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
De tijdstempel van het maken van resources (UTC). |
createdBy |
string |
De identiteit waarmee de resource is gemaakt. |
createdByType |
Het type identiteit waarmee de resource is gemaakt. |
|
lastModifiedAt |
string |
De tijdstempel van de laatste wijziging van de resource (UTC) |
lastModifiedBy |
string |
De identiteit die de resource voor het laatst heeft gewijzigd. |
lastModifiedByType |
Het type identiteit dat de resource voor het laatst heeft gewijzigd. |
UserAssignedIdentity
Informatie over de identiteiten die aan deze toepassing zijn gekoppeld.
Name | Type | Description |
---|---|---|
principalId |
string |
de id-principal-id van de server. |
tenantId |
string |
Tenant-id van de server. |
type |
de typen identiteiten die zijn gekoppeld aan deze resource |
|
userAssignedIdentities |
<string,
User |
vertegenwoordigt de toewijzing van door de gebruiker toegewezen identiteiten. |
UserIdentity
Beschrijft één door de gebruiker toegewezen identiteit die is gekoppeld aan de toepassing.
Name | Type | Description |
---|---|---|
clientId |
string |
de client-id van de service-principal die deze identiteit vertegenwoordigt. |
principalId |
string |
de object-id van de service-principal die deze identiteit vertegenwoordigt. |