Servers - List By Resource Group

Service:

PostgreSQL

API Version:

2024-08-01

Lists all flexible servers in a resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2024-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.
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	ServerListResult	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

List all flexible servers in a resource group.

Sample request

HTTP

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

Java

/**
 * Samples for Servers ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/
     * ServerListByResourceGroup.json
     */
    /**
     * Sample code: ServerListByResourceGroup.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void
        serverListByResourceGroup(com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.servers().listByResourceGroup("testrg", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_list_by_resource_group.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.list_by_resource_group(
        resource_group_name="testrg",
    )
    for item in response:
        print(item)


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

Go

package armpostgresqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ecee919199a39cc0d864410f540aa105bf7cdb64/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json
func ExampleServersClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewServersClient().NewListByResourceGroupPager("testrg", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerListResult = armpostgresqlflexibleservers.ServerListResult{
		// 	Value: []*armpostgresqlflexibleservers.Server{
		// 		{
		// 			Name: to.Ptr("pgtestsvc4"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/flexibleServers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"ElasticServer": to.Ptr("1"),
		// 			},
		// 			Properties: &armpostgresqlflexibleservers.ServerProperties{
		// 				AdministratorLogin: to.Ptr("cloudsa"),
		// 				AuthConfig: &armpostgresqlflexibleservers.AuthConfig{
		// 					ActiveDirectoryAuth: to.Ptr(armpostgresqlflexibleservers.ActiveDirectoryAuthEnumDisabled),
		// 					PasswordAuth: to.Ptr(armpostgresqlflexibleservers.PasswordAuthEnumEnabled),
		// 				},
		// 				AvailabilityZone: to.Ptr("1"),
		// 				Backup: &armpostgresqlflexibleservers.Backup{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-26T01:16:58.372Z"); return t}()),
		// 					GeoRedundantBackup: to.Ptr(armpostgresqlflexibleservers.GeoRedundantBackupEnumDisabled),
		// 				},
		// 				FullyQualifiedDomainName: to.Ptr("c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com"),
		// 				HighAvailability: &armpostgresqlflexibleservers.HighAvailability{
		// 					Mode: to.Ptr(armpostgresqlflexibleservers.HighAvailabilityModeZoneRedundant),
		// 					StandbyAvailabilityZone: to.Ptr("2"),
		// 					State: to.Ptr(armpostgresqlflexibleservers.ServerHAStateHealthy),
		// 				},
		// 				MinorVersion: to.Ptr("6"),
		// 				Network: &armpostgresqlflexibleservers.Network{
		// 					DelegatedSubnetResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet"),
		// 					PrivateDNSZoneArmResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"),
		// 					PublicNetworkAccess: to.Ptr(armpostgresqlflexibleservers.ServerPublicNetworkAccessStateDisabled),
		// 				},
		// 				State: to.Ptr(armpostgresqlflexibleservers.ServerStateReady),
		// 				Storage: &armpostgresqlflexibleservers.Storage{
		// 					AutoGrow: to.Ptr(armpostgresqlflexibleservers.StorageAutoGrowDisabled),
		// 					Iops: to.Ptr[int32](2300),
		// 					StorageSizeGB: to.Ptr[int32](512),
		// 					Tier: to.Ptr(armpostgresqlflexibleservers.AzureManagedDiskPerformanceTiersP20),
		// 				},
		// 				Version: to.Ptr(armpostgresqlflexibleservers.ServerVersionTwelve),
		// 			},
		// 			SKU: &armpostgresqlflexibleservers.SKU{
		// 				Name: to.Ptr("Standard_D4s_v3"),
		// 				Tier: to.Ptr(armpostgresqlflexibleservers.SKUTierGeneralPurpose),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("pgtestsvc1"),
		// 			Type: to.Ptr("Microsoft.DBforPostgreSQL/flexibleServers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"ElasticServer": to.Ptr("1"),
		// 			},
		// 			Properties: &armpostgresqlflexibleservers.ServerProperties{
		// 				AdministratorLogin: to.Ptr("cloudsa"),
		// 				AuthConfig: &armpostgresqlflexibleservers.AuthConfig{
		// 					ActiveDirectoryAuth: to.Ptr(armpostgresqlflexibleservers.ActiveDirectoryAuthEnumDisabled),
		// 					PasswordAuth: to.Ptr(armpostgresqlflexibleservers.PasswordAuthEnumEnabled),
		// 				},
		// 				AvailabilityZone: to.Ptr("1"),
		// 				Backup: &armpostgresqlflexibleservers.Backup{
		// 					BackupRetentionDays: to.Ptr[int32](7),
		// 					EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-26T23:15:38.813Z"); return t}()),
		// 					GeoRedundantBackup: to.Ptr(armpostgresqlflexibleservers.GeoRedundantBackupEnumDisabled),
		// 				},
		// 				FullyQualifiedDomainName: to.Ptr("pgtestsvc1.postgres.database.azure.com"),
		// 				HighAvailability: &armpostgresqlflexibleservers.HighAvailability{
		// 					Mode: to.Ptr(armpostgresqlflexibleservers.HighAvailabilityModeDisabled),
		// 					State: to.Ptr(armpostgresqlflexibleservers.ServerHAStateNotEnabled),
		// 				},
		// 				MinorVersion: to.Ptr("6"),
		// 				Network: &armpostgresqlflexibleservers.Network{
		// 					PublicNetworkAccess: to.Ptr(armpostgresqlflexibleservers.ServerPublicNetworkAccessStateEnabled),
		// 				},
		// 				State: to.Ptr(armpostgresqlflexibleservers.ServerStateReady),
		// 				Storage: &armpostgresqlflexibleservers.Storage{
		// 					AutoGrow: to.Ptr(armpostgresqlflexibleservers.StorageAutoGrowDisabled),
		// 					Iops: to.Ptr[int32](2300),
		// 					StorageSizeGB: to.Ptr[int32](512),
		// 					Tier: to.Ptr(armpostgresqlflexibleservers.AzureManagedDiskPerformanceTiersP20),
		// 				},
		// 				Version: to.Ptr(armpostgresqlflexibleservers.ServerVersionTwelve),
		// 			},
		// 			SKU: &armpostgresqlflexibleservers.SKU{
		// 				Name: to.Ptr("Standard_D4s_v3"),
		// 				Tier: to.Ptr(armpostgresqlflexibleservers.SKUTierGeneralPurpose),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to List all the servers in a given resource group.
 *
 * @summary List all the servers in a given resource group.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json
 */
async function serverListByResourceGroup() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "testrg";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.servers.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.PostgreSql.FlexibleServers.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.PostgreSql.FlexibleServers;

// Generated from example definition: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json
// this example is just showing the usage of "Servers_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "testrg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this PostgreSqlFlexibleServerResource
PostgreSqlFlexibleServerCollection collection = resourceGroupResource.GetPostgreSqlFlexibleServers();

// invoke the operation and iterate over the result
await foreach (PostgreSqlFlexibleServerResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    PostgreSqlFlexibleServerData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2024-08-01&$top=3&$skiptoken=skiptoken",
  "value": [
    {
      "sku": {
        "name": "Standard_D4ds_v5",
        "tier": "GeneralPurpose"
      },
      "systemData": {
        "createdAt": "2024-08-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/exampleserver1.private.postgres.database.azure.com"
        },
        "dataEncryption": {
          "type": "SystemManaged"
        },
        "authConfig": {
          "activeDirectoryAuth": "Enabled",
          "passwordAuth": "Enabled",
          "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt"
        },
        "fullyQualifiedDomainName": "exampleserver1.postgres.database.azure.com",
        "version": "16",
        "minorVersion": "8",
        "administratorLogin": "administratorlogin",
        "state": "Ready",
        "availabilityZone": "1",
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Enabled",
          "earliestRestoreDate": "2024-08-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": "westus",
      "tags": {
        "VnetServer": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver1",
      "name": "exampleserver1",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers"
    },
    {
      "sku": {
        "name": "Standard_D4ds_v5",
        "tier": "GeneralPurpose"
      },
      "identity": {
        "userAssignedIdentities": {
          "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity": {
            "principalId": "pppppppp-pppp-pppp-pppp-pppppppppppp",
            "clientId": "tttttt-tttt-tttt-tttt-tttttttttttt"
          }
        },
        "principalId": "rrrrrrrr-rrrr-rrrr-rrrr-rrrrrrrrrrrr",
        "type": "SystemAssigned,UserAssigned",
        "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt"
      },
      "systemData": {
        "createdAt": "2024-08-01T19:30:22.123456Z"
      },
      "properties": {
        "replica": {
          "role": "Primary",
          "capacity": 5
        },
        "storage": {
          "type": "",
          "iops": 500,
          "tier": "P10",
          "storageSizeGB": 128,
          "autoGrow": "Disabled"
        },
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "privateEndpointConnections": [],
        "dataEncryption": {
          "primaryEncryptionKeyStatus": "Valid",
          "type": "AzureKeyVault",
          "primaryKeyURI": "https://examplekeyvault.vault.azure.net/keys/examplekey/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleprimaryidentity"
        },
        "authConfig": {
          "activeDirectoryAuth": "Enabled",
          "passwordAuth": "Enabled",
          "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt"
        },
        "fullyQualifiedDomainName": "exampleserver2.postgres.database.azure.com",
        "version": "16",
        "minorVersion": "8",
        "administratorLogin": "administratorlogin",
        "state": "Ready",
        "availabilityZone": "1",
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2024-08-01T19:35:22.123456Z"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "Primary",
        "replicaCapacity": 5
      },
      "location": "westus",
      "tags": {},
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver2",
      "name": "exampleserver2",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers"
    }
  ]
}

Definitions

Name	Description
activeDirectoryAuthEnum	Indicates if the server supports Microsoft Entra authentication.
ArmServerKeyType	Data encryption type used by a flexible server.
AuthConfig	Authentication configuration properties of a flexible server.
AzureManagedDiskPerformanceTiers	Storage tier of a flexible server.
Backup	Backup properties of a flexible server.
createdByType	The type of identity that created the resource.
CreateMode	Creation mode of a new flexible server.
DataEncryption	Data encryption properties of a flexible server.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GeoRedundantBackupEnum	Indicates if the server is configured to create geographically redundant backups.
HighAvailability	High availability properties of a flexible server.
HighAvailabilityMode	High availability mode for a flexible server.
IdentityType	Types of identities associated with a flexible server.
keyStatusEnum	Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.
MaintenanceWindow	Maintenance window properties of a flexible server.
Network	Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.
passwordAuthEnum	Indicates if the server supports password based authentication.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	List of private endpoint connections associated with the specified flexible server.
PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.
PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
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.
Replica	Read replica properties of a flexible server. Required only in case that you want to promote a server.
ReplicationPromoteOption	Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.
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 flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating
Server	The list of flexible servers
ServerHAState	Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.
ServerListResult	A list of servers.
ServerPublicNetworkAccessState	Indicates if public network access is enabled or not.
ServerState	Possible states of a flexible server.
ServerVersion	Major version of PostgreSQL database engine.
Sku	Compute tier and size of a flexible server.
SkuTier	Tier of the compute assigned to a flexible server.
Storage	Storage properties of a flexible server.
StorageAutoGrow	Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.
StorageType	Type of storage assigned to a flexible server. Allowed values are Premium_LRS or PremiumV2_LRS. If not specified, it defaults to Premium_LRS.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
UserAssignedIdentity	User assigned managed identities assigned to the flexible server.
UserIdentity	User assigned managed identity associated with a flexible server.

activeDirectoryAuthEnum

Enumeration

Indicates if the server supports Microsoft Entra authentication.

Value	Description
Disabled
Enabled

ArmServerKeyType

Enumeration

Data encryption type used by a flexible server.

Value	Description
AzureKeyVault
SystemManaged

AuthConfig

Object

Authentication configuration properties of a flexible server.

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

AzureManagedDiskPerformanceTiers

Enumeration

Storage tier of a flexible server.

Value	Description
P1
P10
P15
P2
P20
P3
P30
P4
P40
P50
P6
P60
P70
P80

Backup

Object

Backup properties of a flexible server.

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

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

CreateMode

Enumeration

Creation mode of a new flexible server.

Value	Description
Create
Default
GeoRestore
PointInTimeRestore
Replica
ReviveDropped
Update

DataEncryption

Object

Data encryption properties of a flexible server.

Name	Type	Description
geoBackupEncryptionKeyStatus	keyStatusEnum	Status of key used by a flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups.
primaryEncryptionKeyStatus	keyStatusEnum	Status of key used by a flexible 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 flexible 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 flexible server.
type	ArmServerKeyType	Data encryption type used by a flexible server.

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.

GeoRedundantBackupEnum

Enumeration

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

Value	Description
Disabled
Enabled

HighAvailability

Object

High availability properties of a flexible server.

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

HighAvailabilityMode

Enumeration

High availability mode for a flexible server.

Value	Description
Disabled
SameZone
ZoneRedundant

IdentityType

Enumeration

Types of identities associated with a flexible server.

Value	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

keyStatusEnum

Enumeration

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

Value	Description
Invalid
Valid

MaintenanceWindow

Object

Maintenance window properties of a flexible 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.

Network

Object

Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.

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.

passwordAuthEnum

Enumeration

Indicates if the server supports password based authentication.

Value	Description
Disabled
Enabled

PrivateEndpoint

Object

The private endpoint resource.

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

PrivateEndpointConnection

Object

List of private endpoint connections associated with the specified flexible 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}"
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 provisioning state of the private endpoint connection resource.

Value	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeration

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Value	Description
Approved
Pending
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
switchover

Replica

Object

Read replica properties of a flexible server. Required only in case that you want to promote a server.

Name	Type	Description
capacity	integer (int32)	Maximum number of read replicas allowed for a flexible 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	ReplicationPromoteOption	Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.
replicationState	ReplicationState	Indicates the replication state of a read replica. This property is returned only when the target flexible 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.

ReplicationPromoteOption

Enumeration

Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.

Value	Description
forced
planned

ReplicationRole

Enumeration

Role of the server in a replication set.

Value	Description
AsyncReplica
GeoAsyncReplica
None
Primary

ReplicationState

Enumeration

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

Value	Description
Active
Broken
Catchup
Provisioning
Reconfiguring
Updating

Server

Object

The list of flexible servers

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 flexible 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 flexible server.
properties.availabilityZone	string	Availability zone of a flexible server.
properties.backup	Backup	Backup properties of a flexible server.
properties.createMode	CreateMode	Creation mode of a new flexible server.
properties.dataEncryption	DataEncryption	Data encryption properties of a flexible server.
properties.fullyQualifiedDomainName	string	Fully qualified domain name of a flexible server.
properties.highAvailability	HighAvailability	High availability properties of a flexible server.
properties.maintenanceWindow	MaintenanceWindow	Maintenance window properties of a flexible server.
properties.minorVersion	string	Minor version of PostgreSQL database engine.
properties.network	Network	Network properties of a flexible 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 flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.
properties.privateEndpointConnections	PrivateEndpointConnection[]	List of private endpoint connections associated with the specified flexible server.
properties.replica	Replica	Read replica properties of a flexible server. Required only in case that you want to promote a server.
properties.replicaCapacity	integer (int32)	Maximum number of read replicas allowed for a flexible server.
properties.replicationRole	ReplicationRole	Role of the server in a replication set.
properties.sourceServerResourceId	string	Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.
properties.state	ServerState	Possible states of a flexible server.
properties.storage	Storage	Storage properties of a flexible server.
properties.version	ServerVersion	Major version of PostgreSQL database engine.
sku	Sku	Compute tier and size of a flexible 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"

ServerHAState

Enumeration

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

Value	Description
CreatingStandby
FailingOver
Healthy
NotEnabled
RemovingStandby
ReplicatingData

ServerListResult

Object

A list of servers.

Name	Type	Description
nextLink	string	The link used to get the next page of operations.
value	Server[]	The list of flexible servers

ServerPublicNetworkAccessState

Enumeration

Indicates if public network access is enabled or not.

Value	Description
Disabled
Enabled

ServerState

Enumeration

Possible states of a flexible server.

Value	Description
Disabled
Dropping
Ready
Starting
Stopped
Stopping
Updating

ServerVersion

Enumeration

Major version of PostgreSQL database engine.

Value	Description
11
12
13
14
15
16

Sku

Object

Compute tier and size of a flexible server.

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

SkuTier

Enumeration

Tier of the compute assigned to a flexible server.

Value	Description
Burstable
GeneralPurpose
MemoryOptimized

Storage

Object

Storage properties of a flexible server.

Name	Type	Description
autoGrow	StorageAutoGrow	Flag to enable or disable the automatic growth of storage size of a flexible 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.
storageSizeGB	integer (int32)	Size of storage assigned to a flexible server.
throughput	integer (int32)	Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS.
tier	AzureManagedDiskPerformanceTiers	Storage tier of a flexible server.
type	StorageType	Type of storage assigned to a flexible server. Allowed values are Premium_LRS or PremiumV2_LRS. If not specified, it defaults to Premium_LRS.

StorageAutoGrow

Enumeration

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

Value	Description
Disabled
Enabled

StorageType

Enumeration

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

Value	Description
PremiumV2_LRS
Premium_LRS

systemData

Object

Azure Resource Manager metadata containing createdBy and modifiedBy information.

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

User assigned managed identities assigned to the flexible 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 flexible server.
type	IdentityType	Types of identities associated with a flexible server.
userAssignedIdentities	<string,  UserIdentity>	Map of user assigned managed identities.

UserIdentity

Object

User assigned managed identity associated with a flexible 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.