Microsoft.DBforPostgreSQL (preview:2024-11-01)

2025/02/26 • 5 updated methods

Servers_Create (updated)
Description :  Creates a new server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Create",
  "$parameters": {
    "parameters": {
      "$properties": {
        "identity": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "identity": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "identity": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a server. ,
Required: True ,
}
{
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. Burstable. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: represents user assigned identities map. ,
Required: False ,
}
object ,
principalId:
{
Description: the identity principal Id of the server. ,
Required: False ,
}
string ,
type:
{
Description: the types of identities associated with this resource ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: PostgreSQL Server version. ,
Enum:
{
17: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: The minor version of the server. ,
Required: False ,
}
string ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable / disable Storage Auto grow for flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Name of storage tier for IOPS. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: AuthConfig properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: If Enabled, Azure Active Directory authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: If Enabled, Password authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: URI for the key in keyvault for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type to depict if it is System Managed vs Azure Key vault. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Primary encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Geo-backup encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: A value indicating whether Geo-Redundant backup is enabled on the server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest restore point time (ISO8601 format) for server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: public network access is enabled or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: The HA mode for the server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a HA server that is visible to user. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: availability zone information of the standby. ,
Required: False ,
}
string ,
}
,
maintenanceWindow:
{
Description: Maintenance window properties of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability zone information of the server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the server ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. ,
Required: False ,
}
{
role:
{
Description: Used to indicate role of the server in replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Sets the promote mode for a replica server. This is a write only property. ,
Enum:
{
standalone: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Sets the promote options for a replica server. This is a write only property. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: The mode to create a new PostgreSQL server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: The node count for the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. Burstable. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: represents user assigned identities map. ,
Required: False ,
}
object ,
principalId:
{
Description: the identity principal Id of the server. ,
Required: False ,
}
string ,
type:
{
Description: the types of identities associated with this resource ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: PostgreSQL Server version. ,
Enum:
{
17: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: The minor version of the server. ,
Required: False ,
}
string ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable / disable Storage Auto grow for flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Name of storage tier for IOPS. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: AuthConfig properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: If Enabled, Azure Active Directory authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: If Enabled, Password authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: URI for the key in keyvault for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type to depict if it is System Managed vs Azure Key vault. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Primary encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Geo-backup encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: A value indicating whether Geo-Redundant backup is enabled on the server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest restore point time (ISO8601 format) for server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: public network access is enabled or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: The HA mode for the server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a HA server that is visible to user. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: availability zone information of the standby. ,
Required: False ,
}
string ,
}
,
maintenanceWindow:
{
Description: Maintenance window properties of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability zone information of the server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the server ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. ,
Required: False ,
}
{
role:
{
Description: Used to indicate role of the server in replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Sets the promote mode for a replica server. This is a write only property. ,
Enum:
{
standalone: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Sets the promote options for a replica server. This is a write only property. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: The mode to create a new PostgreSQL server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: The node count for the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. Burstable. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: represents user assigned identities map. ,
Required: False ,
}
object ,
principalId:
{
Description: the identity principal Id of the server. ,
Required: False ,
}
string ,
type:
{
Description: the types of identities associated with this resource ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: PostgreSQL Server version. ,
Enum:
{
17: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: The minor version of the server. ,
Required: False ,
}
string ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable / disable Storage Auto grow for flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Name of storage tier for IOPS. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: AuthConfig properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: If Enabled, Azure Active Directory authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: If Enabled, Password authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: URI for the key in keyvault for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type to depict if it is System Managed vs Azure Key vault. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Primary encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Geo-backup encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: A value indicating whether Geo-Redundant backup is enabled on the server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest restore point time (ISO8601 format) for server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: public network access is enabled or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: The HA mode for the server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a HA server that is visible to user. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: availability zone information of the standby. ,
Required: False ,
}
string ,
}
,
maintenanceWindow:
{
Description: Maintenance window properties of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability zone information of the server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the server ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. ,
Required: False ,
}
{
role:
{
Description: Used to indicate role of the server in replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Sets the promote mode for a replica server. This is a write only property. ,
Enum:
{
standalone: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Sets the promote options for a replica server. This is a write only property. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: The mode to create a new PostgreSQL server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: The node count for the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Update (updated)
Description :  Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "identity": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "identity": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server. ,
Required: True ,
}
{
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. Burstable. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: represents user assigned identities map. ,
Required: False ,
}
object ,
principalId:
{
Description: the identity principal Id of the server. ,
Required: False ,
}
string ,
type:
{
Description: the types of identities associated with this resource ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is trying to switch to password authentication and does not have default administrator login. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: PostgreSQL Server version. Version 16 is currently not supported for MVU. ,
Enum:
{
17: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable / disable Storage Auto grow for flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Name of storage tier for IOPS. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: A value indicating whether Geo-Redundant backup is enabled on the server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest restore point time (ISO8601 format) for server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: The HA mode for the server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a HA server that is visible to user. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: availability zone information of the standby. ,
Required: False ,
}
string ,
}
,
maintenanceWindow:
{
Description: Maintenance window properties of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
authConfig:
{
Description: AuthConfig properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: If Enabled, Azure Active Directory authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: If Enabled, Password authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: URI for the key in keyvault for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type to depict if it is System Managed vs Azure Key vault. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Primary encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Geo-backup encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: The mode to update a new PostgreSQL server. ,
Enum:
{
Default: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRole:
{
Description: Replication role of the server ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replica:
{
Description: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. ,
Required: False ,
}
{
role:
{
Description: Used to indicate role of the server in replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Sets the promote mode for a replica server. This is a write only property. ,
Enum:
{
standalone: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Sets the promote options for a replica server. This is a write only property. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network properties of a server. These are required to be passed only in case if server is a private access server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: public network access is enabled or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
}
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: The node count for the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. Burstable. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: represents user assigned identities map. ,
Required: False ,
}
object ,
principalId:
{
Description: the identity principal Id of the server. ,
Required: False ,
}
string ,
type:
{
Description: the types of identities associated with this resource ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: PostgreSQL Server version. ,
Enum:
{
17: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: The minor version of the server. ,
Required: False ,
}
string ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable / disable Storage Auto grow for flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Name of storage tier for IOPS. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: AuthConfig properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: If Enabled, Azure Active Directory authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: If Enabled, Password authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: URI for the key in keyvault for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type to depict if it is System Managed vs Azure Key vault. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Primary encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Geo-backup encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: A value indicating whether Geo-Redundant backup is enabled on the server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest restore point time (ISO8601 format) for server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: public network access is enabled or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: The HA mode for the server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a HA server that is visible to user. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: availability zone information of the standby. ,
Required: False ,
}
string ,
}
,
maintenanceWindow:
{
Description: Maintenance window properties of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability zone information of the server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the server ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. ,
Required: False ,
}
{
role:
{
Description: Used to indicate role of the server in replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Sets the promote mode for a replica server. This is a write only property. ,
Enum:
{
standalone: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Sets the promote options for a replica server. This is a write only property. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: The mode to create a new PostgreSQL server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: The node count for the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Get (updated)
Description :  Gets information about a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Get",
  "$responses": {
    "200": {
      "$properties": {
        "identity": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. Burstable. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: represents user assigned identities map. ,
Required: False ,
}
object ,
principalId:
{
Description: the identity principal Id of the server. ,
Required: False ,
}
string ,
type:
{
Description: the types of identities associated with this resource ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: PostgreSQL Server version. ,
Enum:
{
17: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: The minor version of the server. ,
Required: False ,
}
string ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable / disable Storage Auto grow for flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Name of storage tier for IOPS. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: AuthConfig properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: If Enabled, Azure Active Directory authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: If Enabled, Password authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: URI for the key in keyvault for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type to depict if it is System Managed vs Azure Key vault. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Primary encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Geo-backup encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: A value indicating whether Geo-Redundant backup is enabled on the server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest restore point time (ISO8601 format) for server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: public network access is enabled or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: The HA mode for the server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a HA server that is visible to user. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: availability zone information of the standby. ,
Required: False ,
}
string ,
}
,
maintenanceWindow:
{
Description: Maintenance window properties of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability zone information of the server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the server ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. ,
Required: False ,
}
{
role:
{
Description: Used to indicate role of the server in replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Sets the promote mode for a replica server. This is a write only property. ,
Enum:
{
standalone: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Sets the promote options for a replica server. This is a write only property. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: The mode to create a new PostgreSQL server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: The node count for the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_ListByResourceGroup (updated)
Description :  List all the servers in a given resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "identity": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "UserAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned,UserAssigned",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "UserAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of flexible servers ,
Required: False ,
}
[
{
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. Burstable. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: represents user assigned identities map. ,
Required: False ,
}
object ,
principalId:
{
Description: the identity principal Id of the server. ,
Required: False ,
}
string ,
type:
{
Description: the types of identities associated with this resource ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: PostgreSQL Server version. ,
Enum:
{
17: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: The minor version of the server. ,
Required: False ,
}
string ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable / disable Storage Auto grow for flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Name of storage tier for IOPS. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: AuthConfig properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: If Enabled, Azure Active Directory authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: If Enabled, Password authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: URI for the key in keyvault for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type to depict if it is System Managed vs Azure Key vault. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Primary encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Geo-backup encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: A value indicating whether Geo-Redundant backup is enabled on the server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest restore point time (ISO8601 format) for server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: public network access is enabled or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: The HA mode for the server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a HA server that is visible to user. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: availability zone information of the standby. ,
Required: False ,
}
string ,
}
,
maintenanceWindow:
{
Description: Maintenance window properties of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability zone information of the server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the server ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. ,
Required: False ,
}
{
role:
{
Description: Used to indicate role of the server in replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Sets the promote mode for a replica server. This is a write only property. ,
Enum:
{
standalone: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Sets the promote options for a replica server. This is a write only property. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: The mode to create a new PostgreSQL server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: The node count for the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_List (updated)
Description :  List all the servers in a given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "identity": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "UserAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned,UserAssigned",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "UserAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/flexibleServers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of flexible servers ,
Required: False ,
}
[
{
sku:
{
Description: The SKU (pricing tier) of the server. ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the particular SKU, e.g. Burstable. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: represents user assigned identities map. ,
Required: False ,
}
object ,
principalId:
{
Description: the identity principal Id of the server. ,
Required: False ,
}
string ,
type:
{
Description: the types of identities associated with this resource ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: PostgreSQL Server version. ,
Enum:
{
17: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: The minor version of the server. ,
Required: False ,
}
string ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Max storage allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable / disable Storage Auto grow for flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Name of storage tier for IOPS. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: AuthConfig properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: If Enabled, Azure Active Directory authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: If Enabled, Password authentication is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant id of the server. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: URI for the key in keyvault for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type to depict if it is System Managed vs Azure Key vault. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Primary encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Geo-backup encryption key status for Data encryption enabled server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: A value indicating whether Geo-Redundant backup is enabled on the server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest restore point time (ISO8601 format) for server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: public network access is enabled or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: The HA mode for the server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a HA server that is visible to user. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: availability zone information of the standby. ,
Required: False ,
}
string ,
}
,
maintenanceWindow:
{
Description: Maintenance window properties of a server. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: availability zone information of the server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the server ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. ,
Required: False ,
}
{
role:
{
Description: Used to indicate role of the server in replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Sets the promote mode for a replica server. This is a write only property. ,
Enum:
{
standalone: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Sets the promote options for a replica server. This is a write only property. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: The mode to create a new PostgreSQL server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: The node count for the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}