Compartilhar via

Servers - Get

  • Referência
Serviço:
PostgreSQL
Versão da API:
2022-12-01

Obtém informações sobre um servidor.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome 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

A ID da assinatura de destino.
api-version
 query True

string

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

Server

OK
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ServerGet
ServerGetWithVnet

ServerGet

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00"
    },
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1",
  "name": "pgtestsvc1",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

ServerGetWithVnet

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Definições

Nome Description
activeDirectoryAuthEnum

Se habilitada, a autenticação do Azure Active Directory estará habilitada.
ArmServerKeyType

Tipo de criptografia de dados a ser ilustrado se for Gerenciado pelo Sistema versus Cofre de Chaves do Azure.
AuthConfig

Propriedades AuthConfig de um servidor.
Backup

Propriedades de backup 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

As informações adicionais do erro de gerenciamento de recursos.
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 de HA para o servidor.
IdentityType

os tipos de identidades associadas a esse recurso; atualmente restrito a 'Nenhum e UserAssigned'
MaintenanceWindow

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

Propriedades de rede de um servidor. Essa propriedade Network deve ser passada somente caso você queira que o servidor seja um servidor de acesso privado.
passwordAuthEnum

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

Função de replicação do servidor
Server

Representa um servidor.
ServerHAState

Um estado de um servidor de HA visível para o usuário.
ServerPublicNetworkAccessState

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

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

Versão do Servidor PostgreSQL.
Sku

O SKU (tipo de preço) do servidor.
SkuTier

A camada do SKU específico, por exemplo, com capacidade de intermitência.
Storage

Propriedades de armazenamento de um servidor.
systemData

Os metadados do sistema relacionados a esse recurso.
UserAssignedIdentity

Descreve a identidade do aplicativo.
UserIdentity

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

activeDirectoryAuthEnum

Se habilitada, a autenticação do Azure Active Directory estará habilitada.

Nome Tipo Description
Disabled

string

Enabled

string

ArmServerKeyType

Tipo de criptografia de dados a ser ilustrado se for Gerenciado pelo Sistema versus Cofre de Chaves do Azure.

Nome Tipo Description
AzureKeyVault

string

SystemManaged

string

AuthConfig

Propriedades AuthConfig de um servidor.

Nome Tipo Valor padrão Description
activeDirectoryAuth

activeDirectoryAuthEnum

Se habilitada, a autenticação do Azure Active Directory estará habilitada.
passwordAuth

passwordAuthEnum

Enabled

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

string

ID do locatário do servidor.

Backup

Propriedades de backup de um servidor.

Nome Tipo Valor padrão Description
backupRetentionDays

integer

7

Dias de retenção de backup para o servidor.
earliestRestoreDate

string

A hora mais antiga do ponto de restauração (formato ISO8601) para o servidor.
geoRedundantBackup

GeoRedundantBackupEnum

Disabled

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

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

CreateMode

O modo para criar um novo servidor PostgreSQL.

Nome Tipo Description
Create

string

Default

string

GeoRestore

string

PointInTimeRestore

string

Replica

string

Update

string

DataEncryption

Propriedades de criptografia de dados de um servidor.

Nome Tipo Description
primaryKeyURI

string

URI da chave para criptografia de dados para o servidor primário.
primaryUserAssignedIdentityId

string

ID do recurso para a identidade atribuída pelo usuário a ser usada para criptografia de dados para o servidor primário.
type

ArmServerKeyType

Tipo de criptografia de dados a ser ilustrado se ele é Gerenciado pelo Sistema versus cofre de chaves do Azure.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
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

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

GeoRedundantBackupEnum

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

Nome Tipo Description
Disabled

string

Enabled

string

HighAvailability

Propriedades de alta disponibilidade de um servidor.

Nome Tipo Valor padrão Description
mode

HighAvailabilityMode

Disabled

O modo de HA para o servidor.
standbyAvailabilityZone

string

informações de zona de disponibilidade do modo de espera.
state

ServerHAState

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

HighAvailabilityMode

O modo de HA para o servidor.

Nome Tipo Description
Disabled

string

SameZone

string

ZoneRedundant

string

IdentityType

os tipos de identidades associadas a esse recurso; atualmente restrito a 'Nenhum e UserAssigned'

Nome Tipo Description
None

string

UserAssigned

string

MaintenanceWindow

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

Nome Tipo Valor padrão Description
customWindow

string

Disabled

indica se a janela personalizada está habilitada ou desabilitada
dayOfWeek

integer

0

dia da semana para a 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. Essa propriedade Network deve ser passada somente caso você queira que o servidor seja um servidor de acesso privado.

Nome Tipo Description
delegatedSubnetResourceId

string

ID de recurso do braço de sub-rede delegada. Isso é necessário para ser passado durante a criação, caso queiramos que o servidor seja injetado na VNET, ou seja, servidor de acesso privado. Durante a atualização, passe isso somente se quisermos atualizar o valor de DNS privado zona.
privateDnsZoneArmResourceId

string

ID do recurso do braço da zona DNS privada. Isso é necessário para ser passado durante a criação, caso queiramos que o servidor seja injetado na VNET, ou seja, servidor de acesso privado. Durante a atualização, passe isso somente se quisermos atualizar o valor de DNS privado zona.
publicNetworkAccess

ServerPublicNetworkAccessState

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

passwordAuthEnum

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

Nome Tipo Description
Disabled

string

Enabled

string

ReplicationRole

Função de replicação do servidor

Nome Tipo Description
AsyncReplica

string

GeoAsyncReplica

string

None

string

Primary

string

Server

Representa um servidor.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

UserAssignedIdentity

Descreve a identidade do aplicativo.
location

string

A localização geográfica em que o recurso reside
name

string

O nome do recurso
properties.administratorLogin

string

O nome de logon 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 logon do administrador (necessária para a criação do servidor).
properties.authConfig

AuthConfig

Propriedades AuthConfig de um servidor.
properties.availabilityZone

string

informações de zona de disponibilidade do servidor.
properties.backup

Backup

Propriedades de backup 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ê queira 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 de restauração. Ele é necessário quando 'createMode' é 'PointInTimeRestore' ou 'GeoRestore'.
properties.replicaCapacity

integer

Réplicas permitidas para um servidor.
properties.replicationRole

ReplicationRole

Função de replicação do servidor
properties.sourceServerResourceId

string

A ID do recurso do servidor de origem da qual restaurar. Ele é necessário quando 'createMode' é 'PointInTimeRestore' ou 'GeoRestore' ou 'Replica'. Essa propriedade é retornada somente para o servidor de réplica
properties.state

ServerState

Um estado de um servidor visível para o usuário.
properties.storage

Storage

Propriedades de armazenamento de um servidor.
properties.version

ServerVersion

Versão do Servidor PostgreSQL.
sku

Sku

O SKU (tipo de preço) do servidor.
systemData

systemData

Os metadados do sistema relacionados a esse recurso.
tags

object

Marcas de recurso.
type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ServerHAState

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

Nome Tipo Description
CreatingStandby

string

FailingOver

string

Healthy

string

NotEnabled

string

RemovingStandby

string

ReplicatingData

string

ServerPublicNetworkAccessState

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

Nome Tipo Description
Disabled

string

Enabled

string

ServerState

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

Nome Tipo Description
Disabled

string

Dropping

string

Ready

string

Starting

string

Stopped

string

Stopping

string

Updating

string

ServerVersion

Versão do Servidor PostgreSQL.

Nome Tipo Description
11

string

12

string

13

string

14

string

Sku

O SKU (tipo de preço) do servidor.

Nome 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, com capacidade de intermitência.

SkuTier

A camada do SKU específico, por exemplo, com capacidade de intermitência.

Nome Tipo Description
Burstable

string

GeneralPurpose

string

MemoryOptimized

string

Storage

Propriedades de armazenamento de um servidor.

Nome Tipo Description
storageSizeGB

integer

Armazenamento máximo permitido para um servidor.

systemData

Os metadados do sistema relacionados a esse recurso.

Nome 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

Descreve a identidade do aplicativo.

Nome Tipo Description
tenantId

string

ID do locatário do servidor.
type

IdentityType

os tipos de identidades associadas a esse recurso; atualmente restrito a 'Nenhum e UserAssigned'
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.

Nome Tipo Description
clientId

string

o identificador do cliente da Entidade de Serviço que essa identidade representa.
principalId

string

o identificador de objeto da Entidade de Serviço que essa identidade representa.