Servers - Get

Service:: PostgreSQL

API Version:: 2025-08-01

Gets information about an existing server.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	The name of the server.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Server	OK.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Microsoft Entra OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get information about an existing server that is integrated into a virtual network provided by customer.

Get information about an existing server that isn't integrated into a virtual network provided by customer and has private endpoint connections.

Get information about an existing server.

Get information about an existing server that is integrated into a virtual network provided by customer.

Sample request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01


/**
 * Samples for Servers GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ServersGetWithVnet
     * .json
     */
    /**
     * Sample code: Get information about an existing server that is integrated into a virtual network provided by
     * customer.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void getInformationAboutAnExistingServerThatIsIntegratedIntoAVirtualNetworkProvidedByCustomer(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.servers().getByResourceGroupWithResponse("exampleresourcegroup", "exampleserver",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python servers_get_with_vnet.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.servers.get(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
    )
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ServersGetWithVnet.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

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets information about an existing server.
 *
 * @summary Gets information about an existing server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ServersGetWithVnet.json
 */
async function getInformationAboutAnExistingServerThatIsIntegratedIntoAVirtualNetworkProvidedByCustomer() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "exampleresourcegroup";
  const serverName = "exampleserver";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.servers.get(resourceGroupName, serverName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "sku": {
    "name": "Standard_D4ds_v5",
    "tier": "GeneralPurpose"
  },
  "systemData": {
    "createdAt": "2025-06-01T18:30:22.123456Z"
  },
  "properties": {
    "replica": {
      "role": "Primary",
      "capacity": 5
    },
    "storage": {
      "type": "",
      "iops": 2300,
      "tier": "P20",
      "storageSizeGB": 512,
      "autoGrow": "Disabled"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.Network/virtualNetworks/examplevirtualnetwork/subnets/examplesubnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.Network/privateDnsZones/exampleserver.private.postgres.database.azure.com"
    },
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "fullyQualifiedDomainName": "exampleserver.postgres.database.azure.com",
    "version": "17",
    "minorVersion": "5",
    "administratorLogin": "exampleadministratorlogin",
    "state": "Ready",
    "availabilityZone": "1",
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Enabled",
      "earliestRestoreDate": "2025-06-01T18:35:22.123456Z"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replicationRole": "Primary",
    "replicaCapacity": 5
  },
  "location": "eastus",
  "tags": {
    "VnetServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver",
  "name": "exampleserver",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Get information about an existing server that isn't integrated into a virtual network provided by customer and has private endpoint connections.

Sample request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01


/**
 * Samples for Servers GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/
     * ServersGetWithPrivateEndpoints.json
     */
    /**
     * Sample code: Get information about an existing server that isn't integrated into a virtual network provided by
     * customer and has private endpoint connections.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void
        getInformationAboutAnExistingServerThatIsnTIntegratedIntoAVirtualNetworkProvidedByCustomerAndHasPrivateEndpointConnections(
            com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.servers().getByResourceGroupWithResponse("exampleresourcegroup", "exampleserver",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python servers_get_with_private_endpoints.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.servers.get(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
    )
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ServersGetWithPrivateEndpoints.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

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets information about an existing server.
 *
 * @summary Gets information about an existing server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ServersGetWithPrivateEndpoints.json
 */
async function getInformationAboutAnExistingServerThatIsnTIntegratedIntoAVirtualNetworkProvidedByCustomerAndHasPrivateEndpointConnections() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "exampleresourcegroup";
  const serverName = "exampleserver";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.servers.get(resourceGroupName, serverName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "sku": {
    "name": "Standard_D4ds_v5",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "exampleserver.postgres.database.azure.com",
    "version": "17",
    "minorVersion": "5",
    "administratorLogin": "exampleadministratorlogin",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512,
      "autoGrow": "Disabled",
      "tier": "P20",
      "iops": 2300
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2025-06-01T18:35:22.123456Z"
    },
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleprivateendpointresourcegroup/providers/Microsoft.Network/privateEndpoints/exampleprivateendpoint"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-Approved",
            "actionsRequired": "None"
          },
          "groupIds": [
            "postgresqlServer"
          ],
          "provisioningState": "Succeeded"
        },
        "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/privateEndpointConnections/exampleprivateendpoint.40c899c7-5847-493e-9c9e-d0a0c90aaf92",
        "name": "exampleprivateendpoint.40c899c7-5847-493e-9c9e-d0a0c90aaf92",
        "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections"
      }
    ]
  },
  "location": "eastus",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver",
  "name": "exampleserver",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Get information about an existing server.

Sample request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver?api-version=2025-08-01


/**
 * Samples for Servers GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ServersGet.json
     */
    /**
     * Sample code: Get information about an existing server.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void getInformationAboutAnExistingServer(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.servers().getByResourceGroupWithResponse("exampleresourcegroup", "exampleserver",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python servers_get.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.servers.get(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
    )
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ServersGet.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

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets information about an existing server.
 *
 * @summary Gets information about an existing server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/ServersGet.json
 */
async function getInformationAboutAnExistingServer() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "exampleresourcegroup";
  const serverName = "exampleserver";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.servers.get(resourceGroupName, serverName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "sku": {
    "name": "Standard_D4ds_v5",
    "tier": "GeneralPurpose"
  },
  "systemData": {
    "createdAt": "2025-06-01T18:30:22.123456Z"
  },
  "properties": {
    "replica": {
      "role": "Primary",
      "capacity": 5
    },
    "storage": {
      "type": "",
      "iops": 500,
      "tier": "P10",
      "storageSizeGB": 128,
      "autoGrow": "Disabled"
    },
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "privateEndpointConnections": [],
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "fullyQualifiedDomainName": "exampleserver.postgres.database.azure.com",
    "version": "17",
    "minorVersion": "5",
    "administratorLogin": "exampleadministratorlogin",
    "state": "Ready",
    "availabilityZone": "1",
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Enabled",
      "earliestRestoreDate": "2025-06-01T18:35:22.123456Z"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replicationRole": "Primary",
    "replicaCapacity": 5
  },
  "location": "eastus",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver",
  "name": "exampleserver",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Definitions

Name	Description
AuthConfig	Authentication configuration properties of a server.
AzureManagedDiskPerformanceTier	Storage tier of a server.
Backup	Backup properties of a server.
Cluster	Cluster properties of a server.
createdByType	The type of identity that created the resource.
CreateMode	Creation mode of a new server.
DataEncryption	Data encryption properties of a server.
DataEncryptionType	Data encryption type used by a server.
EncryptionKeyStatus	Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GeographicallyRedundantBackup	Indicates if the server is configured to create geographically redundant backups.
HighAvailability	High availability properties of a server.
HighAvailabilityMode	High availability mode for a server.
HighAvailabilityState	Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.
IdentityType	Types of identities associated with a server.
MaintenanceWindow	Maintenance window properties of a server.
MicrosoftEntraAuth	Indicates if the server supports Microsoft Entra authentication.
Network	Network properties of a server.
PasswordBasedAuth	Indicates if the server supports password based authentication.
PostgresMajorVersion	Major version of PostgreSQL database engine.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ReadReplicaPromoteMode	Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server.
ReadReplicaPromoteOption	Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.
Replica	Replica properties of a server.
ReplicationRole	Role of the server in a replication set.
ReplicationState	Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating
Server	Properties of a server.
ServerPublicNetworkAccessState	Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed.
ServerState	Possible states of a server.
Sku	Compute information of a server.
SkuTier	Tier of the compute assigned to a server.
Storage	Storage properties of a server.
StorageAutoGrow	Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size.
StorageType	Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	Identities associated with a server.
UserIdentity	User assigned managed identity associated with a server.

AuthConfig

Object

Authentication configuration properties of a server.

Name	Type	Default value	Description
activeDirectoryAuth	MicrosoftEntraAuth		Indicates if the server supports Microsoft Entra authentication.
passwordAuth	PasswordBasedAuth	Enabled	Indicates if the server supports password based authentication.
tenantId	string		Identifier of the tenant of the delegated resource.

AzureManagedDiskPerformanceTier

Enumeration

Storage tier of a server.

Value	Description
P1	Entry-level SSD for minimal IOPS, ideal for light development or testing workloads.
P2	Slightly higher IOPS for small-scale applications needing consistent low latency.
P3	Balanced performance for basic production workloads with moderate throughput.
P4	Enhanced IOPS for growing apps with predictable performance needs.
P6	Mid-tier SSD for steady workloads requiring reliable throughput and latency.
P10	Popular choice for general-purpose production workloads with scalable performance.
P15	High IOPS tier for demanding apps with frequent read/write operations.
P20	Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads.
P30	Balanced tier for moderate throughput and latency-sensitive applications.
P40	Enhanced performance for growing production workloads with consistent IOPS demands.
P50	Optimized for enterprise-grade applications needing sustained high throughput.
P60	High-capacity tier for large databases and analytics workloads with elevated IOPS.
P70	Designed for mission-critical systems requiring ultra-low latency and high concurrency.
P80	Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads.

Backup

Object

Backup properties of a server.

Name	Type	Default value	Description
backupRetentionDays	integer (int32)	7	Backup retention days for the server.
earliestRestoreDate	string (date-time)		Earliest restore point time (ISO8601 format) for a server.
geoRedundantBackup	GeographicallyRedundantBackup	Disabled	Indicates if the server is configured to create geographically redundant backups.

Cluster

Object

Cluster properties of a server.

Name	Type	Default value	Description
clusterSize	integer (int32)	0	Number of nodes assigned to the elastic cluster.
defaultDatabaseName	string		Default database name for the elastic cluster.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CreateMode

Enumeration

Creation mode of a new server.

Value	Description
Default	If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'.
Create	Operation creates a new server.
Update	Operation updates an existing server.
PointInTimeRestore	Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time.
GeoRestore	Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled.
Replica	Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary.
ReviveDropped	Operation creates a new server, initialized with the backup of a server that was recently deleted.

DataEncryption

Object

Data encryption properties of a server.

Name	Type	Description
geoBackupEncryptionKeyStatus	EncryptionKeyStatus	Status of key used by a server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.
geoBackupKeyURI	string	Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups.
geoBackupUserAssignedIdentityId	string	Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups.
primaryEncryptionKeyStatus	EncryptionKeyStatus	Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.
primaryKeyURI	string	URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server.
primaryUserAssignedIdentityId	string	Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server.
type	DataEncryptionType	Data encryption type used by a server.

DataEncryptionType

Enumeration

Data encryption type used by a server.

Value	Description
SystemManaged	Encryption managed by Azure using platform managed keys for simplicity and compliance.
AzureKeyVault	Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security.

EncryptionKeyStatus

Enumeration

Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.

Value	Description
Valid	Key is valid and can be used for encryption.
Invalid	Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

GeographicallyRedundantBackup

Enumeration

Indicates if the server is configured to create geographically redundant backups.

Value	Description
Enabled	Server is configured to create geographically redundant backups.
Disabled	Server is not configured to create geographically redundant backups.

HighAvailability

Object

High availability properties of a server.

Name	Type	Default value	Description
mode	HighAvailabilityMode	Disabled	High availability mode for a server.
standbyAvailabilityZone	string		Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.
state	HighAvailabilityState		Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.

HighAvailabilityMode

Enumeration

High availability mode for a server.

Value	Description
Disabled	High availability is disabled for the server.
ZoneRedundant	High availability is enabled for the server, with standby server in a different availability zone than that of the primary.
SameZone	High availability is enabled for the server, with standby server in the same availability zone as the primary.

HighAvailabilityState

Enumeration

Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.

Value	Description
NotEnabled	High availability is not enabled for the server.
CreatingStandby	Standby server is being created.
ReplicatingData	Data is being replicated to the standby server.
FailingOver	Failover operation to the standby server is in progress.
Healthy	Standby server is healthy and ready to take over in case of a failover.
RemovingStandby	Standby server is being removed.

IdentityType

Enumeration

Types of identities associated with a server.

Value	Description
None	No managed identity is assigned to the server.
UserAssigned	One or more managed identities provided by the user are assigned to the server.
SystemAssigned	Azure automatically creates and manages the identity associated to the lifecycle of the server.
SystemAssigned,UserAssigned	Both system-assigned and user-assigned identities are assigned to the server.

MaintenanceWindow

Object

Maintenance window properties of a server.

Name	Type	Default value	Description
customWindow	string	Disabled	Indicates whether custom window is enabled or disabled.
dayOfWeek	integer (int32)	0	Day of the week to be used for maintenance window.
startHour	integer (int32)	0	Start hour to be used for maintenance window.
startMinute	integer (int32)	0	Start minute to be used for maintenance window.

MicrosoftEntraAuth

Enumeration

Indicates if the server supports Microsoft Entra authentication.

Value	Description
Enabled	Server supports Microsoft Entra authentication.
Disabled	Server doesn't support Microsoft Entra authentication.

Network

Object

Network properties of a server.

Name	Type	Description
delegatedSubnetResourceId	string	Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone.
privateDnsZoneArmResourceId	string	Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone.
publicNetworkAccess	ServerPublicNetworkAccessState	Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed.

PasswordBasedAuth

Enumeration

Indicates if the server supports password based authentication.

Value	Description
Enabled	Server supports password based authentication.
Disabled	Server doesn't support password based authentication.

PostgresMajorVersion

Enumeration

Major version of PostgreSQL database engine.

Value	Description
18	PostgreSQL 18.
17	PostgreSQL 17.
16	PostgreSQL 16.
15	PostgreSQL 15.
14	PostgreSQL 14.
13	PostgreSQL 13.
12	PostgreSQL 12.
11	PostgreSQL 11.

PrivateEndpoint

Object

The private endpoint resource.

Name	Type	Description
id	string	The ARM identifier for private endpoint.

PrivateEndpointConnection

Object

The private endpoint connection resource.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.groupIds	string[]	The group ids for the private endpoint resource.
properties.privateEndpoint	PrivateEndpoint	The private endpoint resource.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

The current provisioning state.

Value	Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Enumeration

The private endpoint connection status.

Value	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ReadReplicaPromoteMode

Enumeration

Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server.

Value	Description
Standalone	Read replica will become an independent server.
Switchover	Read replica will swap roles with primary server.

ReadReplicaPromoteOption

Enumeration

Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.

Value	Description
Planned	The operation will wait for data in the read replica to be fully synchronized with its source server, before it initiates the operation.
Forced	The operation will not wait for data in the read replica to be synchronized with its source server, before it initiates the operation.

Replica

Object

Replica properties of a server.

Name	Type	Description
capacity	integer (int32)	Maximum number of read replicas allowed for a server.
promoteMode	ReadReplicaPromoteMode	Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server.
promoteOption	ReadReplicaPromoteOption	Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.
replicationState	ReplicationState	Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating
role	ReplicationRole	Role of the server in a replication set.

ReplicationRole

Enumeration

Role of the server in a replication set.

Value	Description
None	No replication role assigned; the server operates independently.
Primary	Acts as the source server for replication to one or more replicas.
AsyncReplica	Receives data asynchronously from a primary server within the same region.
GeoAsyncReplica	Receives data asynchronously from a primary server in a different region for geographical redundancy.

ReplicationState

Enumeration

Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating

Value	Description
Active	Read replica is fully synchronized and actively replicating data from the primary server.
Catchup	Read replica is behind the primary server and is currently catching up with pending changes.
Provisioning	Read replica is being created and is in process of getting initialized.
Updating	Read replica is undergoing some changes it can be changing compute size of promoting it to primary server.
Broken	Replication has failed or been interrupted.
Reconfiguring	Read replica is being reconfigured, possibly due to changes in source or settings.

Server

Object

Properties of a server.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	UserAssignedIdentity	User assigned managed identities assigned to the server.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.administratorLogin	string	Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted.
properties.administratorLoginPassword	string (password)	Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.
properties.authConfig	AuthConfig	Authentication configuration properties of a server.
properties.availabilityZone	string	Availability zone of a server.
properties.backup	Backup	Backup properties of a server.
properties.cluster	Cluster	Cluster properties of a server.
properties.createMode	CreateMode	Creation mode of a new server.
properties.dataEncryption	DataEncryption	Data encryption properties of a server.
properties.fullyQualifiedDomainName	string	Fully qualified domain name of a server.
properties.highAvailability	HighAvailability	High availability properties of a server.
properties.maintenanceWindow	MaintenanceWindow	Maintenance window properties of a server.
properties.minorVersion	string	Minor version of PostgreSQL database engine.
properties.network	Network	Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer.
properties.pointInTimeUTC	string (date-time)	Creation time (in ISO8601 format) of the backup which you want to restore in the new server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.
properties.privateEndpointConnections	PrivateEndpointConnection[]	List of private endpoint connections associated with the specified server.
properties.replica	Replica	Read replica properties of a server. Required only in case that you want to promote a server.
properties.replicaCapacity	integer (int32)	Maximum number of read replicas allowed for a server.
properties.replicationRole	ReplicationRole	Role of the server in a replication set.
properties.sourceServerResourceId	string	Identifier of the server to be used as the source of the new server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target server is a read replica.
properties.state	ServerState	Possible states of a server.
properties.storage	Storage	Storage properties of a server.
properties.version	PostgresMajorVersion	Major version of PostgreSQL database engine.
sku	Sku	Compute tier and size of a server.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ServerPublicNetworkAccessState

Enumeration

Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed.

Value	Description
Enabled	Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server.
Disabled	Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints.

ServerState

Enumeration

Possible states of a server.

Value	Description
Ready	Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level.
Dropping	Server is being deleted.
Disabled	Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription.
Starting	PostgreSQL database engine is being restarted.
Stopping	Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated.
Stopped	Compute resources associated with the server are being stopped and deallocated.
Updating	Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine.
Restarting	PostgreSQL database engine is being restarted.
Inaccessible	Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state.
Provisioning	Server is in the process of being created.

Sku

Object

Compute information of a server.

Name	Type	Description
name	string	Name by which is known a given compute size assigned to a server.
tier	SkuTier	Tier of the compute assigned to a server.

SkuTier

Enumeration

Tier of the compute assigned to a server.

Value	Description
Burstable	Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements.
GeneralPurpose	Balanced compute and memory for most workloads, offering scalable performance and I/O throughput.
MemoryOptimized	High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency.

Storage

Object

Storage properties of a server.

Name	Type	Description
autoGrow	StorageAutoGrow	Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size.
iops	integer (int32)	Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.
storageSizeGB	integer (int32)	Size of storage assigned to a server.
throughput	integer (int32)	Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.
tier	AzureManagedDiskPerformanceTier	Storage tier of a server.
type	StorageType	Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.

StorageAutoGrow

Enumeration

Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size.

Value	Description
Enabled	Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size.
Disabled	Server should not automatically grow storage size when available space is nearing zero.

StorageType

Enumeration

Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.

Value	Description
Premium_LRS	Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads.
PremiumV2_LRS	Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads.
UltraSSD_LRS	High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

Identities associated with a server.

Name	Type	Description
principalId	string	Identifier of the object of the service principal associated to the user assigned managed identity.
tenantId	string	Identifier of the tenant of a server.
type	IdentityType	Types of identities associated with a server.
userAssignedIdentities	<string, UserIdentity>	Map of user assigned managed identities.

UserIdentity

Object

User assigned managed identity associated with a server.

Name	Type	Description
clientId	string	Identifier of the client of the service principal associated to the user assigned managed identity.
principalId	string	Identifier of the object of the service principal associated to the user assigned managed identity.

Share via

Servers - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get information about an existing server that is integrated into a virtual network provided by customer.

Sample request

Sample response

Get information about an existing server that isn't integrated into a virtual network provided by customer and has private endpoint connections.

Sample request

Sample response

Get information about an existing server.

Sample request

Sample response

Definitions

AuthConfig

AzureManagedDiskPerformanceTier

Backup

Cluster

createdByType

CreateMode

DataEncryption

DataEncryptionType

EncryptionKeyStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicallyRedundantBackup

HighAvailability

HighAvailabilityMode

HighAvailabilityState

IdentityType

MaintenanceWindow

MicrosoftEntraAuth

Network

PasswordBasedAuth

PostgresMajorVersion

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ReadReplicaPromoteMode

ReadReplicaPromoteOption

Replica

ReplicationRole

ReplicationState

Server

ServerPublicNetworkAccessState

ServerState

Sku

SkuTier

Storage

StorageAutoGrow

StorageType

systemData

UserAssignedIdentity

UserIdentity