Replicas - List By Server
Liste todas as réplicas de um determinado servidor.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas?api-version=2022-12-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas. |
server
|
path | True |
string |
O nome do servidor. Regex pattern: |
subscription
|
path | True |
string |
O ID da subscrição de destino. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Resposta de erro que descreve a razão pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
ReplicasListByServer
Sample Request
GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername/replicas?api-version=2022-12-01
Sample Response
{
"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"
}
]
}
Definições
Name | Description |
---|---|
active |
Se Ativado, a autenticação do Azure Active Directory está ativada. |
Arm |
Tipo de encriptação de dados para ilustrar se é Gerido pelo Sistema vs. Cofre de chaves do Azure. |
Auth |
Propriedades de configuração de autenticação de um servidor |
Backup |
Propriedades de cópia de segurança de um servidor |
created |
O tipo de identidade que criou o recurso. |
Create |
O modo para criar um novo servidor PostgreSQL. |
Data |
Propriedades de encriptação de dados de um servidor |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Geo |
Um valor que indica se Geo-Redundant cópia de segurança está ativada no servidor. |
High |
Propriedades de elevada disponibilidade de um servidor |
High |
O modo HA para o servidor. |
Identity |
os tipos de identidades associadas a este recurso; atualmente restrito a "Nenhum e UserAssigned" |
Maintenance |
Propriedades da janela de manutenção de um servidor. |
Network |
Propriedades de rede de um servidor. |
password |
Se Ativado, a autenticação por palavra-passe está ativada. |
Replication |
Utilizado para indicar a função do servidor no conjunto de replicação. |
Server |
Representa um servidor. |
Server |
Um estado de um servidor HA que é visível para o utilizador. |
Server |
Uma lista de servidores. |
Server |
o acesso à rede pública está ativado ou não |
Server |
Um estado de um servidor que é visível para o utilizador. |
Server |
A versão de um servidor. |
Sku |
Propriedades relacionadas com informações de SKU de um servidor. |
Sku |
A camada do SKU específico, por exemplo, Expansível. |
Storage |
Propriedades de armazenamento de um servidor |
system |
Metadados relativos à criação e última modificação do recurso. |
User |
Informações que descrevem as identidades associadas a esta aplicação. |
User |
Descreve uma única identidade atribuída pelo utilizador associada à aplicação. |
activeDirectoryAuthEnum
Se Ativado, a autenticação do Azure Active Directory está ativada.
Name | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ArmServerKeyType
Tipo de encriptação de dados para ilustrar se é Gerido pelo Sistema vs. Cofre de chaves do Azure.
Name | Tipo | Description |
---|---|---|
AzureKeyVault |
string |
|
SystemManaged |
string |
AuthConfig
Propriedades de configuração de autenticação de um servidor
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
activeDirectoryAuth |
Se ativado, a autenticação do Azure Active Directory está ativada. |
||
passwordAuth | Enabled |
Se ativado, a autenticação por palavra-passe está ativada. |
|
tenantId |
string |
ID do inquilino do servidor. |
Backup
Propriedades de cópia de segurança de um servidor
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
backupRetentionDays |
integer |
7 |
Dias de retenção da cópia de segurança para o servidor. |
earliestRestoreDate |
string |
O tempo de ponto de restauro mais antigo (ISO8601 formato) para o servidor. |
|
geoRedundantBackup | Disabled |
Um valor que indica se Geo-Redundant cópia de segurança está ativada no servidor. |
createdByType
O tipo de identidade que criou o recurso.
Name | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
O modo para criar um novo servidor PostgreSQL.
Name | Tipo | Description |
---|---|---|
Create |
string |
|
Default |
string |
|
GeoRestore |
string |
|
PointInTimeRestore |
string |
|
Replica |
string |
|
Update |
string |
DataEncryption
Propriedades de encriptação de dados de um servidor
Name | Tipo | Description |
---|---|---|
primaryKeyURI |
string |
URI da chave para encriptação de dados para o servidor primário. |
primaryUserAssignedIdentityId |
string |
ID do Recurso para a identidade atribuída pelo utilizador a ser utilizada para encriptação de dados para o servidor primário. |
type |
Tipo de encriptação de dados para ilustrar se é Gerido pelo Sistema vs. Cofre de chaves do Azure. |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informações adicionais. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta a erros
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
GeoRedundantBackupEnum
Um valor que indica se Geo-Redundant cópia de segurança está ativada no servidor.
Name | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
HighAvailability
Propriedades de elevada disponibilidade de um servidor
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
mode | Disabled |
O modo HA para o servidor. |
|
standbyAvailabilityZone |
string |
informações da zona de disponibilidade do modo de espera. |
|
state |
Um estado de um servidor HA que é visível para o utilizador. |
HighAvailabilityMode
O modo HA para o servidor.
Name | Tipo | Description |
---|---|---|
Disabled |
string |
|
SameZone |
string |
|
ZoneRedundant |
string |
IdentityType
os tipos de identidades associadas a este recurso; atualmente restrito a "Nenhum e UserAssigned"
Name | Tipo | Description |
---|---|---|
None |
string |
|
UserAssigned |
string |
MaintenanceWindow
Propriedades da janela de manutenção de um servidor.
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
customWindow |
string |
Disabled |
indica se a janela personalizada está ativada ou desativada |
dayOfWeek |
integer |
0 |
dia da semana para janela de manutenção |
startHour |
integer |
0 |
hora de início da janela de manutenção |
startMinute |
integer |
0 |
minuto de início para a janela de manutenção |
Network
Propriedades de rede de um servidor.
Name | Tipo | Description |
---|---|---|
delegatedSubnetResourceId |
string |
ID de recurso do arm de sub-rede delegado. Isto tem de ser transmitido durante a criação, caso pretendamos que o servidor seja injetado na VNET, ou seja, servidor de acesso privado. Durante a atualização, transmita esta opção apenas se quisermos atualizar o valor para DNS Privado zona. |
privateDnsZoneArmResourceId |
string |
ID de recurso do arm da zona dns privado. Isto tem de ser transmitido durante a criação, caso pretendamos que o servidor seja injetado na VNET, ou seja, servidor de acesso privado. Durante a atualização, transmita esta opção apenas se quisermos atualizar o valor para DNS Privado zona. |
publicNetworkAccess |
o acesso à rede pública está ativado ou não |
passwordAuthEnum
Se Ativado, a autenticação por palavra-passe está ativada.
Name | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ReplicationRole
Utilizado para indicar a função do servidor no conjunto de replicação.
Name | Tipo | Description |
---|---|---|
AsyncReplica |
string |
|
GeoAsyncReplica |
string |
|
None |
string |
|
Primary |
string |
Server
Representa um servidor.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Descreve a identidade da aplicação. |
|
location |
string |
A localização geográfica onde reside o recurso |
name |
string |
O nome do recurso |
properties.administratorLogin |
string |
O nome de início de sessão do administrador de um servidor. Só pode ser especificado quando o servidor está a ser criado (e é necessário para a criação). |
properties.administratorLoginPassword |
string |
A palavra-passe de início de sessão do administrador (necessária para a criação do servidor). |
properties.authConfig |
Propriedades AuthConfig de um servidor. |
|
properties.availabilityZone |
string |
informações da zona de disponibilidade do servidor. |
properties.backup |
Propriedades de cópia de segurança de um servidor. |
|
properties.createMode |
O modo para criar um novo servidor PostgreSQL. |
|
properties.dataEncryption |
Propriedades de encriptação de dados de um servidor. |
|
properties.fullyQualifiedDomainName |
string |
O nome de domínio completamente qualificado de um servidor. |
properties.highAvailability |
Propriedades de elevada disponibilidade de um servidor. |
|
properties.maintenanceWindow |
Propriedades da janela de manutenção de um servidor. |
|
properties.minorVersion |
string |
A versão secundária do servidor. |
properties.network |
Propriedades de rede de um servidor. Esta propriedade Rede só tem de ser transmitida caso pretenda que o servidor seja servidor de acesso privado. |
|
properties.pointInTimeUTC |
string |
Hora de criação do ponto de restauro (ISO8601 formato), especificando o tempo a partir do qual restaurar. É necessário quando "createMode" é "PointInTimeRestore" ou "GeoRestore". |
properties.replicaCapacity |
integer |
Réplicas permitidas para um servidor. |
properties.replicationRole |
Função de replicação do servidor |
|
properties.sourceServerResourceId |
string |
O ID de recurso do servidor de origem a partir do qual restaurar. É necessário quando "createMode" é "PointInTimeRestore" ou "GeoRestore" ou "Réplica". Esta propriedade é devolvida apenas para o servidor de Réplica |
properties.state |
Um estado de um servidor que é visível para o utilizador. |
|
properties.storage |
Propriedades de armazenamento de um servidor. |
|
properties.version |
Versão do Servidor PostgreSQL. |
|
sku |
O SKU (escalão de preço) do servidor. |
|
systemData |
Os metadados do sistema relacionados com este recurso. |
|
tags |
object |
Etiquetas de recursos. |
type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
ServerHAState
Um estado de um servidor HA que é visível para o utilizador.
Name | Tipo | Description |
---|---|---|
CreatingStandby |
string |
|
FailingOver |
string |
|
Healthy |
string |
|
NotEnabled |
string |
|
RemovingStandby |
string |
|
ReplicatingData |
string |
ServerListResult
Uma lista de servidores.
Name | Tipo | Description |
---|---|---|
nextLink |
string |
A ligação utilizada para obter a página seguinte das operações. |
value |
Server[] |
A lista de servidores flexíveis |
ServerPublicNetworkAccessState
o acesso à rede pública está ativado ou não
Name | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ServerState
Um estado de um servidor que é visível para o utilizador.
Name | Tipo | Description |
---|---|---|
Disabled |
string |
|
Dropping |
string |
|
Ready |
string |
|
Starting |
string |
|
Stopped |
string |
|
Stopping |
string |
|
Updating |
string |
ServerVersion
A versão de um servidor.
Name | Tipo | Description |
---|---|---|
11 |
string |
|
12 |
string |
|
13 |
string |
|
14 |
string |
Sku
Propriedades relacionadas com informações de SKU de um servidor.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome do sku, normalmente, camada + família + núcleos, por exemplo, Standard_D4s_v3. |
tier |
A camada do SKU específico, por exemplo, Expansível. |
SkuTier
A camada do SKU específico, por exemplo, Expansível.
Name | Tipo | Description |
---|---|---|
Burstable |
string |
|
GeneralPurpose |
string |
|
MemoryOptimized |
string |
Storage
Propriedades de armazenamento de um servidor
Name | Tipo | Description |
---|---|---|
storageSizeGB |
integer |
Armazenamento máximo permitido para um servidor. |
systemData
Metadados relativos à criação e última modificação do recurso.
Name | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
UserAssignedIdentity
Informações que descrevem as identidades associadas a esta aplicação.
Name | Tipo | Description |
---|---|---|
tenantId |
string |
ID do inquilino do servidor. |
type |
os tipos de identidades associadas a este recurso; atualmente restrito a "Nenhum e UserAssigned" |
|
userAssignedIdentities |
<string,
User |
representa o mapa de identidades atribuídas pelo utilizador. |
UserIdentity
Descreve uma única identidade atribuída pelo utilizador associada à aplicação.
Name | Tipo | Description |
---|---|---|
clientId |
string |
o identificador de cliente do Principal de Serviço que esta identidade representa. |
principalId |
string |
o identificador de objeto do Principal de Serviço que esta identidade representa. |