Replicas - List By Server

Referência

Serviço:: PostgreSQL

Versão da API:: 2024-11-01-preview

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=2024-11-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor. Padrão Regex: `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*`
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	ServerListResult	OK
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ReplicasListByServer

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

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="testrg",
        server_name="sourcepgservername",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/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

Resposta da amostra

Código de estado:: 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,
          "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"
    }
  ]
}

Definições

Name	Description
activeDirectoryAuthEnum	Se Habilitado, a autenticação do Azure Ative Directory será habilitada.
ArmServerKeyType	Tipo de criptografia de dados a ser descrito se for System Managed vs Azure Key vault.
AuthConfig	Propriedades de configuração de autenticação de um servidor
AzureManagedDiskPerformanceTiers	Nome da camada de armazenamento para IOPS.
Backup	Propriedades de backup de um servidor
Cluster	Propriedades de cluster de um servidor.
createdByType	O tipo de identidade que criou o recurso.
CreateMode	O modo para criar um novo servidor PostgreSQL.
DataEncryption	Propriedades de criptografia de dados de um servidor
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GeoRedundantBackupEnum	Um valor que indica se Geo-Redundant backup está habilitado no servidor.
HighAvailability	Propriedades de alta disponibilidade de um servidor
HighAvailabilityMode	O modo HA para o servidor.
IdentityType	Os tipos de identidades associadas a este recurso
keyStatusEnum	Status da chave de criptografia primária para o servidor habilitado para criptografia de dados.
MaintenanceWindow	Propriedades da janela de manutenção de um servidor.
Network	Propriedades de rede de um servidor.
passwordAuthEnum	Se Habilitado, a autenticação de senha estará habilitada.
PrivateEndpoint	O recurso de ponto de extremidade privado.
PrivateEndpointConnection	O recurso de conexão de ponto de extremidade privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
ReadReplicaPromoteMode	Define o modo de promoção para um servidor de réplica. Esta é uma propriedade somente gravação.
Replica	Propriedades de réplica de um servidor
ReplicationPromoteOption	Define as opções de promoção para um servidor de réplica. Esta é uma propriedade somente gravação.
ReplicationRole	Usado para indicar a função do servidor no conjunto de replicação.
ReplicationState	Obtém o estado de replicação de um servidor de réplica. Essa propriedade é retornada somente para réplicas api call. Os valores suportados são Ativo, Catchup, Provisionamento, Atualização, Quebrado, Reconfiguração
Server	Representa um servidor.
ServerHAState	Um estado de um servidor HA que é visível para o usuário.
ServerListResult	Uma lista de servidores.
ServerPublicNetworkAccessState	O acesso à rede pública está habilitado ou não
ServerState	Um estado de um servidor que é visível para o usuário.
ServerVersion	A versão de um servidor.
Sku	Informações de Sku relacionadas às propriedades de um servidor.
SkuTier	A camada do SKU específico, por exemplo, Burstable.
Storage	Propriedades de armazenamento de um servidor
StorageAutoGrow	Sinalizar para ativar/desativar o crescimento automático de armazenamento para um servidor flexível.
StorageType	Tipo de armazenamento para o servidor. Os valores permitidos são Premium_LRS, PremiumV2_LRS e UltraSSD_LRS. O padrão é Premium_LRS se não for especificado
systemData	Metadados referentes à criação e última modificação do recurso.
UserAssignedIdentity	Informações que descrevem as identidades associadas a esta aplicação.
UserIdentity	Descreve uma única identidade atribuída pelo usuário associada ao aplicativo.

activeDirectoryAuthEnum

Se Habilitado, a autenticação do Azure Ative Directory será habilitada.

Name	Tipo	Description
Disabled	string
Enabled	string

ArmServerKeyType

Tipo de criptografia de dados a ser descrito se for System Managed vs Azure Key vault.

Name	Tipo	Description
AzureKeyVault	string
SystemManaged	string

AuthConfig

Propriedades de configuração de autenticação de um servidor

Name	Tipo	Default value	Description
activeDirectoryAuth	activeDirectoryAuthEnum		Se Habilitado, a autenticação do Azure Ative Directory será habilitada.
passwordAuth	passwordAuthEnum	Enabled	Se Habilitado, a autenticação de senha estará habilitada.
tenantId	string		ID do locatário do servidor.

AzureManagedDiskPerformanceTiers

Nome da camada de armazenamento para IOPS.

Name	Tipo	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

Propriedades de backup de um servidor

Name	Tipo	Default value	Description
backupRetentionDays	integer	7	Dias de retenção de backup para o servidor.
earliestRestoreDate	string		O primeiro tempo de ponto de restauração (formato ISO8601) para o servidor.
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	Um valor que indica se Geo-Redundant backup está habilitado no servidor.

Cluster

Propriedades de cluster de um servidor.

Name	Tipo	Default value	Description
clusterSize	integer	0	A contagem de nós para o cluster.

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
ReviveDropped	string
Update	string

DataEncryption

Propriedades de criptografia de dados de um servidor

Name	Tipo	Description
geoBackupEncryptionKeyStatus	keyStatusEnum	Status da chave de criptografia de backup geográfico para o servidor habilitado para criptografia de dados.
geoBackupKeyURI	string	URI para a chave no keyvault para criptografia de dados para geo-backup do servidor.
geoBackupUserAssignedIdentityId	string	ID do recurso para a identidade atribuída ao usuário a ser usada para criptografia de dados para backup geográfico do servidor.
primaryEncryptionKeyStatus	keyStatusEnum	Status da chave de criptografia primária para o servidor habilitado para criptografia de dados.
primaryKeyURI	string	URI para a chave no keyvault para criptografia de dados do servidor primário.
primaryUserAssignedIdentityId	string	ID do recurso para a identidade atribuída ao usuário a ser usada para criptografia de dados do servidor primário.
type	ArmServerKeyType	Tipo de criptografia de dados a ser descrito se for System Managed vs Azure Key vault.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GeoRedundantBackupEnum

Um valor que indica se Geo-Redundant backup está habilitado no servidor.

Name	Tipo	Description
Disabled	string
Enabled	string

HighAvailability

Propriedades de alta disponibilidade de um servidor

Name	Tipo	Default value	Description
mode	HighAvailabilityMode	Disabled	O modo HA para o servidor.
standbyAvailabilityZone	string		Informações da zona de disponibilidade do modo de espera.
state	ServerHAState		Um estado de um servidor HA que é visível para o usuário.

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

Name	Tipo	Description
None	string
SystemAssigned	string
UserAssigned	string

keyStatusEnum

Status da chave de criptografia primária para o servidor habilitado para criptografia de dados.

Name	Tipo	Description
Invalid	string
Valid	string

MaintenanceWindow

Propriedades da janela de manutenção de um servidor.

Name	Tipo	Default value	Description
customWindow	string	Disabled	Indica se a janela personalizada está habilitada ou desabilitada
dayOfWeek	integer	0	dia da semana para janela de manutenção
startHour	integer	0	hora de início para a 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 do recurso de braço de sub-rede delegado. Isso é necessário para ser passado durante a criação, no caso de querermos que o servidor seja injetado VNET, ou seja, servidor de acesso privado. Durante a atualização, passe isso somente se quisermos atualizar o valor para a zona DNS privada.
privateDnsZoneArmResourceId	string	ID de recurso de braço de zona dns privada. Isso é necessário para ser passado durante a criação, no caso de querermos que o servidor seja injetado VNET, ou seja, servidor de acesso privado. Durante a atualização, passe isso somente se quisermos atualizar o valor para a zona DNS privada.
publicNetworkAccess	ServerPublicNetworkAccessState	O acesso à rede pública está habilitado ou não

passwordAuthEnum

Se Habilitado, a autenticação de senha estará habilitada.

Name	Tipo	Description
Disabled	string
Enabled	string

PrivateEndpoint

O recurso de ponto de extremidade privado.

Name	Tipo	Description
id	string	O identificador ARM para o ponto de extremidade privado.

PrivateEndpointConnection

O recurso de conexão de ponto de extremidade privado.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.groupIds	string[]	As ids de grupo para o recurso de ponto de extremidade privado.
properties.privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento do recurso de conexão de ponto de extremidade privado.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

Name	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

O status da conexão de ponto de extremidade privado.

Name	Tipo	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.

Name	Tipo	Description
actionsRequired	string	Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

ReadReplicaPromoteMode

Define o modo de promoção para um servidor de réplica. Esta é uma propriedade somente gravação.

Name	Tipo	Description
standalone	string
switchover	string

Replica

Propriedades de réplica de um servidor

Name	Tipo	Description
capacity	integer	Réplicas permitidas para um servidor.
promoteMode	ReadReplicaPromoteMode	Define o modo de promoção para um servidor de réplica. Esta é uma propriedade somente gravação.
promoteOption	ReplicationPromoteOption	Define as opções de promoção para um servidor de réplica. Esta é uma propriedade somente gravação.
replicationState	ReplicationState	Obtém o estado de replicação de um servidor de réplica. Essa propriedade é retornada somente para réplicas api call. Os valores suportados são Ativo, Catchup, Provisionamento, Atualização, Quebrado, Reconfiguração
role	ReplicationRole	Usado para indicar a função do servidor no conjunto de replicação.

ReplicationPromoteOption

Define as opções de promoção para um servidor de réplica. Esta é uma propriedade somente gravação.

Name	Tipo	Description
forced	string
planned	string

ReplicationRole

Usado para indicar a função do servidor no conjunto de replicação.

Name	Tipo	Description
AsyncReplica	string
GeoAsyncReplica	string
None	string
Primary	string

ReplicationState

Obtém o estado de replicação de um servidor de réplica. Essa propriedade é retornada somente para réplicas api call. Os valores suportados são Ativo, Catchup, Provisionamento, Atualização, Quebrado, Reconfiguração

Name	Tipo	Description
Active	string
Broken	string
Catchup	string
Provisioning	string
Reconfiguring	string
Updating	string

Server

Representa um servidor.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	UserAssignedIdentity	Descreve a identidade do aplicativo.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.administratorLogin	string	O nome de login do administrador de um servidor. Só pode ser especificado quando o servidor está sendo criado (e é necessário para a criação).
properties.administratorLoginPassword	string	A senha de login do administrador (necessária para a criação do servidor).
properties.authConfig	AuthConfig	AuthConfig propriedades de um servidor.
properties.availabilityZone	string	Informações da zona de disponibilidade do servidor.
properties.backup	Backup	Propriedades de backup de um servidor.
properties.cluster	Cluster	Propriedades de cluster de um servidor.
properties.createMode	CreateMode	O modo para criar um novo servidor PostgreSQL.
properties.dataEncryption	DataEncryption	Propriedades de criptografia de dados de um servidor.
properties.fullyQualifiedDomainName	string	O nome de domínio totalmente qualificado de um servidor.
properties.highAvailability	HighAvailability	Propriedades de alta disponibilidade de um servidor.
properties.maintenanceWindow	MaintenanceWindow	Propriedades da janela de manutenção de um servidor.
properties.minorVersion	string	A versão secundária do servidor.
properties.network	Network	Propriedades de rede de um servidor. Essa propriedade Network deve ser passada somente caso você deseje que o servidor seja um servidor de acesso privado.
properties.pointInTimeUTC	string	Tempo de criação do ponto de restauração (formato ISO8601), especificando o tempo a partir do qual restaurar. É necessário quando 'createMode' é 'PointInTimeRestore' ou 'GeoRestore' ou 'ReviveDropped'.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lista de conexões de ponto de extremidade privadas associadas ao recurso especificado.
properties.replica	Replica	Propriedades de réplica de um servidor. Essas propriedades de réplica devem ser passadas somente caso você queira promover um servidor.
properties.replicaCapacity	integer	Réplicas permitidas para um servidor.
properties.replicationRole	ReplicationRole	Função de replicação do servidor
properties.sourceServerResourceId	string	O ID do recurso do servidor de origem a partir do qual restaurar. É necessário quando 'createMode' é 'PointInTimeRestore' ou 'GeoRestore' ou 'Replica' ou 'ReviveDropped'. Essa propriedade é retornada somente para o servidor de réplica
properties.state	ServerState	Um estado de um servidor que é visível para o usuário.
properties.storage	Storage	Propriedades de armazenamento de um servidor.
properties.version	ServerVersion	Versão do PostgreSQL Server.
sku	Sku	O SKU (nível de preço) do servidor.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags 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 usuário.

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	O link usado para obter a próxima página de operações.
value	Server[]	A lista de servidores flexíveis

ServerPublicNetworkAccessState

O acesso à rede pública está habilitado ou não

Name	Tipo	Description
Disabled	string
Enabled	string

ServerState

Um estado de um servidor que é visível para o usuário.

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
15	string
16	string
17	string

Sku

Informações de Sku relacionadas às propriedades de um servidor.

Name	Tipo	Description
name	string	O nome do sku, normalmente, camada + família + núcleos, por exemplo, Standard_D4s_v3.
tier	SkuTier	A camada do SKU específico, por exemplo, Burstable.

SkuTier

A camada do SKU específico, por exemplo, Burstable.

Name	Tipo	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

Storage

Propriedades de armazenamento de um servidor

Name	Tipo	Description
autoGrow	StorageAutoGrow	Sinalizar para ativar/desativar o crescimento automático de armazenamento para um servidor flexível.
iops	integer	Quantidade de IOPS da camada de armazenamento. Esta propriedade deve ser definida para o tipo de armazenamento PremiumV2_LRS e UltraSSD_LRS.
storageSizeGB	integer	Armazenamento máximo permitido para um servidor.
throughput	integer	Taxa de transferência de armazenamento para o servidor. Isso deve ser definido para o tipo de armazenamento PremiumV2_LRS e UltraSSD_LRS.
tier	AzureManagedDiskPerformanceTiers	Nome da camada de armazenamento para IOPS.
type	StorageType	Tipo de armazenamento para o servidor. Os valores permitidos são Premium_LRS, PremiumV2_LRS e UltraSSD_LRS. O padrão é Premium_LRS se não for especificado

StorageAutoGrow

Sinalizar para ativar/desativar o crescimento automático de armazenamento para um servidor flexível.

Name	Tipo	Description
Disabled	string
Enabled	string

StorageType

Tipo de armazenamento para o servidor. Os valores permitidos são Premium_LRS, PremiumV2_LRS e UltraSSD_LRS. O padrão é Premium_LRS se não for especificado

Name	Tipo	Description
PremiumV2_LRS	string
Premium_LRS	string
UltraSSD_LRS	string

systemData

Metadados referentes à 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	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	createdByType	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 locatário do servidor.
type	IdentityType	Os tipos de identidades associadas a este recurso
userAssignedIdentities	<string, UserIdentity>	Representa o mapa de identidades atribuídas pelo usuário.

UserIdentity

Descreve uma única identidade atribuída pelo usuário associada ao aplicativo.

Name	Tipo	Description
clientId	string	o identificador de cliente da entidade de serviço que esta identidade representa.
principalId	string	o identificador de objeto da entidade de serviço que essa identidade representa.

Partilhar via