Microsoft.DBforPostgreSQL (preview:2025-01-01)

2025/04/29 • 72 new methods

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}
{
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 ,
objectId:
{
Description: Guid of the objectId for the administrator. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for adding an Microsoft Entra Administrator for a server. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Microsoft Entra Administrator. ,
Required: False ,
}
{
principalType:
{
Description: The principal type used to represent the type of Microsoft Entra Administrator. ,
Enum:
{
Unknown: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: False ,
}
enum ,
principalName:
{
Description: Microsoft Entra Administrator principal name. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId of the Microsoft Entra Administrator. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Microsoft Entra Administrator. ,
Required: True ,
}
{
principalType:
{
Description: The principal type used to represent the type of Microsoft Entra Administrator. ,
Enum:
{
Unknown: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: False ,
}
enum ,
principalName:
{
Description: Microsoft Entra Administrator principal name. ,
Required: False ,
}
string ,
objectId:
{
Description: The objectId of the Microsoft Entra Administrator. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId of the Microsoft Entra Administrator. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Microsoft Entra Administrator. ,
Required: True ,
}
{
principalType:
{
Description: The principal type used to represent the type of Microsoft Entra Administrator. ,
Enum:
{
Unknown: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: False ,
}
enum ,
principalName:
{
Description: Microsoft Entra Administrator principal name. ,
Required: False ,
}
string ,
objectId:
{
Description: The objectId of the Microsoft Entra Administrator. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId of the Microsoft Entra Administrator. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Administrators_Delete (new)
Description :  Deletes an Microsoft Entra Administrator associated with the server.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}
{
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 ,
objectId:
{
Description: Guid of the objectId for the administrator. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Administrators_Get (new)
Description :  Gets information about a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}
{
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 ,
objectId:
{
Description: Guid of the objectId for the administrator. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Microsoft Entra Administrator. ,
Required: True ,
}
{
principalType:
{
Description: The principal type used to represent the type of Microsoft Entra Administrator. ,
Enum:
{
Unknown: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: False ,
}
enum ,
principalName:
{
Description: Microsoft Entra Administrator principal name. ,
Required: False ,
}
string ,
objectId:
{
Description: The objectId of the Microsoft Entra Administrator. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId of the Microsoft Entra Administrator. ,
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 ,
}
,
]
,
}
,
}
Administrators_ListByServer (new)
Description :  List all the AAD administrators for a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators
{
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)

{
value:
{
Description: The list of Microsoft Entra Administrators ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Microsoft Entra Administrator. ,
Required: True ,
}
{
principalType:
{
Description: The principal type used to represent the type of Microsoft Entra Administrator. ,
Enum:
{
Unknown: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: False ,
}
enum ,
principalName:
{
Description: Microsoft Entra Administrator principal name. ,
Required: False ,
}
string ,
objectId:
{
Description: The objectId of the Microsoft Entra Administrator. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenantId of the Microsoft Entra Administrator. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of Microsoft Entra administrators. ,
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 ,
}
,
]
,
}
,
}
Backups_Create (new)
Description :  Create a specific backup for PostgreSQL flexible server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}
{
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 ,
backupName:
{
Description: The name of the backup. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Enum:
{
Full: No description available. ,
Customer On-Demand: No description available. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Enum:
{
Full: No description available. ,
Customer On-Demand: No description available. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Backups_Delete (new)
Description :  Deletes a specific backup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}
{
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 ,
backupName:
{
Description: The name of the backup. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Backups_Get (new)
Description :  Get specific backup for a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}
{
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 ,
backupName:
{
Description: The name of the backup. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Enum:
{
Full: No description available. ,
Customer On-Demand: No description available. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
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 ,
}
,
]
,
}
,
}
Backups_ListByServer (new)
Description :  List all the backups for a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups
{
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)

{
value:
{
Description: The list of backups of a server. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a server backup. ,
Required: False ,
}
{
backupType:
{
Description: Backup type. ,
Enum:
{
Full: No description available. ,
Customer On-Demand: No description available. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Backup completed time (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Backup source ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
LocationBasedCapabilities_Execute (new)
Description :  Get capabilities at specified location in a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/capabilities
{
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 ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of supported capabilities. ,
Required: False ,
}
[
{
name:
{
Description: Name of flexible servers capability ,
Required: False ,
}
string ,
supportedServerEditions:
{
Description: List of supported flexible server editions ,
Required: False ,
}
[
{
name:
{
Description: Server edition name ,
Required: False ,
}
string ,
defaultSkuName:
{
Description: Default sku name for the server edition ,
Required: False ,
}
string ,
supportedStorageEditions:
{
Description: The list of editions supported by this server edition. ,
Required: False ,
}
[
{
name:
{
Description: Storage edition name ,
Required: False ,
}
string ,
defaultStorageSizeMb:
{
Description: Default storage size in MB for storage edition ,
Format: int64 ,
Required: False ,
}
integer ,
supportedStorageMb:
{
Description: Flexible server supported storage range in MB ,
Required: False ,
}
[
{
supportedIops:
{
Description: Supported IOPS ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMaximumIops:
{
Description: Maximum IOPS supported by this #Vcores or PremiumV2_LRS Storage Size ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeMb:
{
Description: Storage size in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maximumStorageSizeMb:
{
Description: Maximum value of Storage size in MB ,
Format: int64 ,
Required: False ,
}
integer ,
supportedThroughput:
{
Description: Values of throughput in MB/s ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMaximumThroughput:
{
Description: Maximum values of throughput in MB/s ,
Format: int32 ,
Required: False ,
}
integer ,
defaultIopsTier:
{
Description: Default tier for IOPS ,
Required: False ,
}
string ,
supportedIopsTiers:
{
Description: List of available options to upgrade the storage performance ,
Required: False ,
}
[
{
name:
{
Description: Name to represent Storage tier capability ,
Required: False ,
}
string ,
iops:
{
Description: Supported IOPS for this storage tier ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
supportedServerSkus:
{
Description: List of supported server SKUs. ,
Required: False ,
}
[
{
name:
{
Description: Sku name ,
Required: False ,
}
string ,
vCores:
{
Description: Supported vCores ,
Format: int32 ,
Required: False ,
}
integer ,
supportedIops:
{
Description: Supported IOPS ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMemoryPerVcoreMb:
{
Description: Supported memory per vCore in MB ,
Format: int64 ,
Required: False ,
}
integer ,
supportedZones:
{
Description: List of supported Availability Zones. E.g. "1", "2", "3" ,
Required: False ,
}
[
string ,
]
,
supportedHaMode:
{
Description: Supported high availability mode ,
Required: False ,
}
[
string ,
]
,
supportedFeatures:
{
Description: The supported features. ,
Required: False ,
}
[
{
name:
{
Description: Name of feature ,
Required: False ,
}
string ,
status:
{
Description: Status of feature ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
securityProfile:
{
Description: The value of security profile indicating if its confidential vm ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
supportedServerVersions:
{
Description: The list of server versions supported for this capability. ,
Required: False ,
}
[
{
name:
{
Description: Server version ,
Required: False ,
}
string ,
supportedVersionsToUpgrade:
{
Description: Supported servers versions to upgrade ,
Required: False ,
}
[
string ,
]
,
supportedFeatures:
{
Description: The supported features. ,
Required: False ,
}
[
{
name:
{
Description: Name of feature ,
Required: False ,
}
string ,
status:
{
Description: Status of feature ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
supportedFeatures:
{
Description: The supported features. ,
Required: False ,
}
[
{
name:
{
Description: Name of feature ,
Required: False ,
}
string ,
status:
{
Description: Status of feature ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
fastProvisioningSupported:
{
Description: Gets a value indicating whether fast provisioning is supported. "Enabled" means fast provisioning is supported. "Disabled" stands for fast provisioning is not supported. Will be deprecated in future, please look to Supported Features for "FastProvisioning". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
supportedFastProvisioningEditions:
{
Description: List of supported server editions for fast provisioning ,
Required: False ,
}
[
{
supportedTier:
{
Description: Fast provisioning supported tier name ,
Required: False ,
}
string ,
supportedSku:
{
Description: Fast provisioning supported sku name ,
Required: False ,
}
string ,
supportedStorageGb:
{
Description: Fast provisioning supported storage in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
supportedServerVersions:
{
Description: Fast provisioning supported version ,
Required: False ,
}
string ,
serverCount:
{
Description: Count of servers in cache matching the spec ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
geoBackupSupported:
{
Description: Determines if geo-backup is supported in this region. "Enabled" means geo-backup is supported. "Disabled" stands for geo-back is not supported. Will be deprecated in future, please look to Supported Features for "GeoBackup". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundantHaSupported:
{
Description: A value indicating whether Zone Redundant HA is supported in this region. "Enabled" means zone redundant HA is supported. "Disabled" stands for zone redundant HA is not supported. Will be deprecated in future, please look to Supported Features for "ZoneRedundantHa". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundantHaAndGeoBackupSupported:
{
Description: A value indicating whether Zone Redundant HA and Geo-backup is supported in this region. "Enabled" means zone redundant HA and geo-backup is supported. "Disabled" stands for zone redundant HA and geo-backup is not supported. Will be deprecated in future, please look to Supported Features for "ZoneRedundantHaAndGeoBackup". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageAutoGrowthSupported:
{
Description: A value indicating whether storage auto-grow is supported in this region. "Enabled" means storage auto-grow is supported. "Disabled" stands for storage auto-grow is not supported. Will be deprecated in future, please look to Supported Features for "StorageAutoGrowth". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
onlineResizeSupported:
{
Description: A value indicating whether online resize is supported in this region for the given subscription. "Enabled" means storage online resize is supported. "Disabled" means storage online resize is not supported. Will be deprecated in future, please look to Supported Features for "OnlineResize". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
restricted:
{
Description: A value indicating whether this region is restricted. "Enabled" means region is restricted. "Disabled" stands for region is not restricted. Will be deprecated in future, please look to Supported Features for "Restricted". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
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 ,
}
,
]
,
}
,
}
ServerCapabilities_List (new)
Description :  Get capabilities for a flexible server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/capabilities
{
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)

{
value:
{
Description: A list of supported capabilities. ,
Required: False ,
}
[
{
name:
{
Description: Name of flexible servers capability ,
Required: False ,
}
string ,
supportedServerEditions:
{
Description: List of supported flexible server editions ,
Required: False ,
}
[
{
name:
{
Description: Server edition name ,
Required: False ,
}
string ,
defaultSkuName:
{
Description: Default sku name for the server edition ,
Required: False ,
}
string ,
supportedStorageEditions:
{
Description: The list of editions supported by this server edition. ,
Required: False ,
}
[
{
name:
{
Description: Storage edition name ,
Required: False ,
}
string ,
defaultStorageSizeMb:
{
Description: Default storage size in MB for storage edition ,
Format: int64 ,
Required: False ,
}
integer ,
supportedStorageMb:
{
Description: Flexible server supported storage range in MB ,
Required: False ,
}
[
{
supportedIops:
{
Description: Supported IOPS ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMaximumIops:
{
Description: Maximum IOPS supported by this #Vcores or PremiumV2_LRS Storage Size ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeMb:
{
Description: Storage size in MB ,
Format: int64 ,
Required: False ,
}
integer ,
maximumStorageSizeMb:
{
Description: Maximum value of Storage size in MB ,
Format: int64 ,
Required: False ,
}
integer ,
supportedThroughput:
{
Description: Values of throughput in MB/s ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMaximumThroughput:
{
Description: Maximum values of throughput in MB/s ,
Format: int32 ,
Required: False ,
}
integer ,
defaultIopsTier:
{
Description: Default tier for IOPS ,
Required: False ,
}
string ,
supportedIopsTiers:
{
Description: List of available options to upgrade the storage performance ,
Required: False ,
}
[
{
name:
{
Description: Name to represent Storage tier capability ,
Required: False ,
}
string ,
iops:
{
Description: Supported IOPS for this storage tier ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
supportedServerSkus:
{
Description: List of supported server SKUs. ,
Required: False ,
}
[
{
name:
{
Description: Sku name ,
Required: False ,
}
string ,
vCores:
{
Description: Supported vCores ,
Format: int32 ,
Required: False ,
}
integer ,
supportedIops:
{
Description: Supported IOPS ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMemoryPerVcoreMb:
{
Description: Supported memory per vCore in MB ,
Format: int64 ,
Required: False ,
}
integer ,
supportedZones:
{
Description: List of supported Availability Zones. E.g. "1", "2", "3" ,
Required: False ,
}
[
string ,
]
,
supportedHaMode:
{
Description: Supported high availability mode ,
Required: False ,
}
[
string ,
]
,
supportedFeatures:
{
Description: The supported features. ,
Required: False ,
}
[
{
name:
{
Description: Name of feature ,
Required: False ,
}
string ,
status:
{
Description: Status of feature ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
securityProfile:
{
Description: The value of security profile indicating if its confidential vm ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
supportedServerVersions:
{
Description: The list of server versions supported for this capability. ,
Required: False ,
}
[
{
name:
{
Description: Server version ,
Required: False ,
}
string ,
supportedVersionsToUpgrade:
{
Description: Supported servers versions to upgrade ,
Required: False ,
}
[
string ,
]
,
supportedFeatures:
{
Description: The supported features. ,
Required: False ,
}
[
{
name:
{
Description: Name of feature ,
Required: False ,
}
string ,
status:
{
Description: Status of feature ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
supportedFeatures:
{
Description: The supported features. ,
Required: False ,
}
[
{
name:
{
Description: Name of feature ,
Required: False ,
}
string ,
status:
{
Description: Status of feature ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
fastProvisioningSupported:
{
Description: Gets a value indicating whether fast provisioning is supported. "Enabled" means fast provisioning is supported. "Disabled" stands for fast provisioning is not supported. Will be deprecated in future, please look to Supported Features for "FastProvisioning". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
supportedFastProvisioningEditions:
{
Description: List of supported server editions for fast provisioning ,
Required: False ,
}
[
{
supportedTier:
{
Description: Fast provisioning supported tier name ,
Required: False ,
}
string ,
supportedSku:
{
Description: Fast provisioning supported sku name ,
Required: False ,
}
string ,
supportedStorageGb:
{
Description: Fast provisioning supported storage in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
supportedServerVersions:
{
Description: Fast provisioning supported version ,
Required: False ,
}
string ,
serverCount:
{
Description: Count of servers in cache matching the spec ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
geoBackupSupported:
{
Description: Determines if geo-backup is supported in this region. "Enabled" means geo-backup is supported. "Disabled" stands for geo-back is not supported. Will be deprecated in future, please look to Supported Features for "GeoBackup". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundantHaSupported:
{
Description: A value indicating whether Zone Redundant HA is supported in this region. "Enabled" means zone redundant HA is supported. "Disabled" stands for zone redundant HA is not supported. Will be deprecated in future, please look to Supported Features for "ZoneRedundantHa". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundantHaAndGeoBackupSupported:
{
Description: A value indicating whether Zone Redundant HA and Geo-backup is supported in this region. "Enabled" means zone redundant HA and geo-backup is supported. "Disabled" stands for zone redundant HA and geo-backup is not supported. Will be deprecated in future, please look to Supported Features for "ZoneRedundantHaAndGeoBackup". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
storageAutoGrowthSupported:
{
Description: A value indicating whether storage auto-grow is supported in this region. "Enabled" means storage auto-grow is supported. "Disabled" stands for storage auto-grow is not supported. Will be deprecated in future, please look to Supported Features for "StorageAutoGrowth". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
onlineResizeSupported:
{
Description: A value indicating whether online resize is supported in this region for the given subscription. "Enabled" means storage online resize is supported. "Disabled" means storage online resize is not supported. Will be deprecated in future, please look to Supported Features for "OnlineResize". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
restricted:
{
Description: A value indicating whether this region is restricted. "Enabled" means region is restricted. "Disabled" stands for region is not restricted. Will be deprecated in future, please look to Supported Features for "Restricted". ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
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 ,
}
,
]
,
}
,
}
CheckNameAvailability_Execute (new)
Description :  Check the availability of name for resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability
{
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 ,
nameAvailabilityRequest:
{
Description: The required parameters for checking if resource name is available. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: name of the PostgreSQL server. ,
Required: False ,
}
string ,
type:
{
Description: type of the server ,
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 ,
}
,
]
,
}
,
}
CheckNameAvailabilityWithLocation_Execute (new)
Description :  Check the availability of name for resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkNameAvailability
{
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 ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: The required parameters for checking if resource name is available. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: name of the PostgreSQL server. ,
Required: False ,
}
string ,
type:
{
Description: type of the server ,
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 ,
}
,
]
,
}
,
}
Configurations_ListByServer (new)
Description :  List all the configurations in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations
{
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)

{
value:
{
Description: The list of server configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Configuration dynamic or static. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Configuration read-only or not. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Configuration is pending restart or not. ,
Required: False ,
}
boolean ,
unit:
{
Description: Configuration unit. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Configuration documentation link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Configurations_Get (new)
Description :  Gets information about a configuration of server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}
{
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 ,
configurationName:
{
Description: The name of the server configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Configuration dynamic or static. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Configuration read-only or not. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Configuration is pending restart or not. ,
Required: False ,
}
boolean ,
unit:
{
Description: Configuration unit. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Configuration documentation link. ,
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 ,
}
,
]
,
}
,
}
Configurations_Update (new)
Description :  Updates a configuration of a server.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}
{
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 ,
configurationName:
{
Description: The name of the server configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Configuration dynamic or static. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Configuration read-only or not. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Configuration is pending restart or not. ,
Required: False ,
}
boolean ,
unit:
{
Description: Configuration unit. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Configuration documentation link. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Configuration dynamic or static. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Configuration read-only or not. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Configuration is pending restart or not. ,
Required: False ,
}
boolean ,
unit:
{
Description: Configuration unit. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Configuration documentation link. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Configuration dynamic or static. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Configuration read-only or not. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Configuration is pending restart or not. ,
Required: False ,
}
boolean ,
unit:
{
Description: Configuration unit. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Configuration documentation link. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Configurations_Put (new)
Description :  Updates a configuration of a server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}
{
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 ,
configurationName:
{
Description: The name of the server configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Configuration dynamic or static. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Configuration read-only or not. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Configuration is pending restart or not. ,
Required: False ,
}
boolean ,
unit:
{
Description: Configuration unit. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Configuration documentation link. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Configuration dynamic or static. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Configuration read-only or not. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Configuration is pending restart or not. ,
Required: False ,
}
boolean ,
unit:
{
Description: Configuration unit. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Configuration documentation link. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. Required to update the configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Configuration dynamic or static. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Configuration read-only or not. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Configuration is pending restart or not. ,
Required: False ,
}
boolean ,
unit:
{
Description: Configuration unit. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Configuration documentation link. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Databases_Create (new)
Description :  Creates a new database or updates an existing database.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}
{
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 ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a database. ,
Required: True ,
}
{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Databases_Delete (new)
Description :  Deletes a database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}
{
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 ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Databases_Get (new)
Description :  Gets information about a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}
{
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 ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
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 ,
}
,
]
,
}
,
}
Databases_ListByServer (new)
Description :  List all the databases in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases
{
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)

{
value:
{
Description: The list of databases housed in a server ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a database. ,
Required: False ,
}
{
charset:
{
Description: The charset of the database. ,
Required: False ,
}
string ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of databases. ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
FirewallRules_CreateOrUpdate (new)
Description :  Creates a new firewall rule or updates an existing firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
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 ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a firewall rule. ,
Required: True ,
}
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
FirewallRules_Delete (new)
Description :  Deletes a PostgreSQL server firewall rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
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 ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
FirewallRules_Get (new)
Description :  List all the firewall rules in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
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 ,
firewallRuleName:
{
Description: The name of the server firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
FirewallRules_ListByServer (new)
Description :  List all the firewall rules in a given PostgreSQL server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules
{
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)

{
value:
{
Description: The list of firewall rules in a server. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}
,
]
,
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_Create (new)
Description :  Creates a new server.
Reference :  Link ¶

⚼ 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. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: 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 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, Microsoft Entra 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. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: 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 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, Microsoft Entra 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. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: 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 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, Microsoft Entra 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 (new)
Description :  Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
Reference :  Link ¶

⚼ 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 17 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 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, Microsoft Entra 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. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: 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 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, Microsoft Entra 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_Delete (new)
Description :  Deletes a server.
Reference :  Link ¶

⚼ Request

DELETE:  /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)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ 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 (new)
Description :  Gets information about a server.
Reference :  Link ¶

⚼ 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. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: 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 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, Microsoft Entra 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 (new)
Description :  List all the servers in a given resource group.
Reference :  Link ¶

⚼ 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. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: 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 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, Microsoft Entra 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 (new)
Description :  List all the servers in a given subscription.
Reference :  Link ¶

⚼ 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. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: 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 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, Microsoft Entra 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 ,
}
,
]
,
}
,
}
FlexibleServer_TriggerLtrPreBackup (new)
Description :  PreBackup operation performs all the checks that are needed for the subsequent long term retention backup operation to succeed.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrPreBackup
{
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: Request body for operation ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Response for the LTR pre-backup API call ,
}
{
properties:
{
Description: Additional Properties for the pre backup response ,
Required: True ,
}
{
numberOfContainers:
{
Description: Number of storage containers the plugin will use during backup. More than one containers may be used for size limitations, parallelism, or redundancy etc. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: ErrorCode string in the event of a failure. ,
}
string ,
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
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 ,
}
,
]
,
}
,
}
,
}
FlexibleServer_StartLtrBackup (new)
Description :  Start the Long Term Retention Backup operation
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startLtrBackup
{
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: Request body for operation ,
Required: True ,
}
{
targetDetails:
{
Description: Backup store detail for target server ,
Required: True ,
}
{
sasUriList:
{
Description: List of SAS uri of storage containers where backup data is to be streamed/copied. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Response for the LTR backup API call ,
}
{
properties:
{
Description: Long Term Retention Backup Operation Resource Properties ,
Required: False ,
}
{
datasourceSizeInBytes:
{
Description: Size of datasource in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataTransferredInBytes:
{
Description: Data transferred in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
backupName:
{
Description: Name of Backup operation ,
Required: False ,
}
string ,
backupMetadata:
{
Description: Metadata to be stored in RP. Store everything that will be required to perform a successful restore using this Recovery point. e.g. Versions, DataFormat etc ,
Required: False ,
}
string ,
status:
{
Description: Service-set extensible enum indicating the status of operation ,
Enum:
{
Running: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time of the operation. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: End time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: PercentageCompleted ,
Format: double ,
Required: False ,
}
number ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The number of seconds to wait before checking the status of the asynchronous operation. ,
}
integer ,
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: ErrorCode string in the event of a failure. ,
}
string ,
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
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 ,
}
,
]
,
}
,
}
,
}
ltrBackupOperations_Get (new)
Description :  Gets the result of the give long term retention backup operation for the flexible server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrBackupOperations/{backupName}
{
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 ,
backupName:
{
Description: The name of the backup. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Long Term Retention Backup Operation Resource Properties ,
Required: False ,
}
{
datasourceSizeInBytes:
{
Description: Size of datasource in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataTransferredInBytes:
{
Description: Data transferred in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
backupName:
{
Description: Name of Backup operation ,
Required: False ,
}
string ,
backupMetadata:
{
Description: Metadata to be stored in RP. Store everything that will be required to perform a successful restore using this Recovery point. e.g. Versions, DataFormat etc ,
Required: False ,
}
string ,
status:
{
Description: Service-set extensible enum indicating the status of operation ,
Enum:
{
Running: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time of the operation. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: End time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: PercentageCompleted ,
Format: double ,
Required: False ,
}
number ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
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 ,
}
,
]
,
}
,
}
ltrBackupOperations_ListByServer (new)
Description :  Gets the result of the give long term retention backup operations for the flexible server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrBackupOperations
{
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)

{
value:
{
Description: The list of long term retention server backup operations ,
Required: False ,
}
[
{
properties:
{
Description: Long Term Retention Backup Operation Resource Properties ,
Required: False ,
}
{
datasourceSizeInBytes:
{
Description: Size of datasource in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
dataTransferredInBytes:
{
Description: Data transferred in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
backupName:
{
Description: Name of Backup operation ,
Required: False ,
}
string ,
backupMetadata:
{
Description: Metadata to be stored in RP. Store everything that will be required to perform a successful restore using this Recovery point. e.g. Versions, DataFormat etc ,
Required: False ,
}
string ,
status:
{
Description: Service-set extensible enum indicating the status of operation ,
Enum:
{
Running: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time of the operation. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: End time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: PercentageCompleted ,
Format: double ,
Required: False ,
}
number ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Migrations_Create (new)
Description :  Creates a new migration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID of the target database server. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the target database server. ,
Required: True ,
}
string ,
targetDbServerName:
{
Description: The name of the target database server. ,
Required: True ,
}
string ,
migrationName:
{
Description: The name of the migration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating a migration. ,
Required: True ,
}
{
properties:
{
Description: Migration resource properties. ,
Required: False ,
}
{
migrationId:
{
Description: ID for migration, a GUID. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of migration ,
Required: False ,
}
{
state:
{
Description: State of migration ,
Enum:
{
InProgress: No description available. ,
WaitingForUserAction: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ValidationFailed: No description available. ,
CleaningUp: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error message, if any, for the migration state ,
Required: False ,
}
string ,
currentSubStateDetails:
{
Description: Current Migration sub state details. ,
Required: False ,
}
{
currentSubState:
{
Description: Migration sub state. ,
Enum:
{
PerformingPreRequisiteSteps: No description available. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: No description available. ,
WaitingForDBsToMigrateSpecification: No description available. ,
WaitingForTargetDBOverwriteConfirmation: No description available. ,
WaitingForDataMigrationScheduling: No description available. ,
WaitingForDataMigrationWindow: No description available. ,
MigratingData: No description available. ,
WaitingForCutoverTrigger: No description available. ,
CompletingMigration: No description available. ,
Completed: No description available. ,
CancelingRequestedDBMigrations: No description available. ,
ValidationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
dbDetails:
{
Required: False ,
}
object ,
validationDetails:
{
Description: Details for the validation for migration ,
Required: False ,
}
{
status:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Validation Start date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: Validation End date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
serverLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
startedOn:
{
Description: Start date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of database level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: ResourceId of the private endpoint migration instance ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: There are two types of migration modes Online and Offline ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: This indicates the supported Migration option for the migration ,
Enum:
{
Validate: No description available. ,
Migrate: No description available. ,
ValidateAndMigrate: No description available. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
AzureVM: No description available. ,
PostgreSQLSingleServer: No description available. ,
AWS_RDS: No description available. ,
AWS_AURORA: No description available. ,
AWS_EC2: No description available. ,
GCP_CloudSQL: No description available. ,
GCP_AlloyDB: No description available. ,
GCP_Compute: No description available. ,
EDB: No description available. ,
EDB_Oracle_Server: No description available. ,
EDB_PostgreSQL: No description available. ,
PostgreSQLFlexibleServer: No description available. ,
PostgreSQLCosmosDB: No description available. ,
Huawei_RDS: No description available. ,
Huawei_Compute: No description available. ,
Heroku_PostgreSQL: No description available. ,
Crunchy_PostgreSQL: No description available. ,
ApsaraDB_RDS: No description available. ,
Digital_Ocean_Droplets: No description available. ,
Digital_Ocean_PostgreSQL: No description available. ,
Supabase_PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types ,
Enum:
{
Prefer: No description available. ,
Require: No description available. ,
VerifyCA: No description available. ,
VerifyFull: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of the source database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of the target database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: ResourceId of the source database server ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters ,
Required: False ,
}
{
adminCredentials:
{
Description: Admin credentials for source and target servers ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the username for the source server. This user need not be an admin. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the username for the target server. This user need not be an admin. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Number of databases to migrate ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup LogicalReplicationOnSourceDb, if needed ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: To migrate roles and permissions we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates whether the data migration should start right away ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: To trigger cutover for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: To trigger cancel for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases send cancel flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Migration resource properties. ,
Required: False ,
}
{
migrationId:
{
Description: ID for migration, a GUID. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of migration ,
Required: False ,
}
{
state:
{
Description: State of migration ,
Enum:
{
InProgress: No description available. ,
WaitingForUserAction: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ValidationFailed: No description available. ,
CleaningUp: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error message, if any, for the migration state ,
Required: False ,
}
string ,
currentSubStateDetails:
{
Description: Current Migration sub state details. ,
Required: False ,
}
{
currentSubState:
{
Description: Migration sub state. ,
Enum:
{
PerformingPreRequisiteSteps: No description available. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: No description available. ,
WaitingForDBsToMigrateSpecification: No description available. ,
WaitingForTargetDBOverwriteConfirmation: No description available. ,
WaitingForDataMigrationScheduling: No description available. ,
WaitingForDataMigrationWindow: No description available. ,
MigratingData: No description available. ,
WaitingForCutoverTrigger: No description available. ,
CompletingMigration: No description available. ,
Completed: No description available. ,
CancelingRequestedDBMigrations: No description available. ,
ValidationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
dbDetails:
{
Required: False ,
}
object ,
validationDetails:
{
Description: Details for the validation for migration ,
Required: False ,
}
{
status:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Validation Start date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: Validation End date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
serverLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
startedOn:
{
Description: Start date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of database level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: ResourceId of the private endpoint migration instance ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: There are two types of migration modes Online and Offline ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: This indicates the supported Migration option for the migration ,
Enum:
{
Validate: No description available. ,
Migrate: No description available. ,
ValidateAndMigrate: No description available. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
AzureVM: No description available. ,
PostgreSQLSingleServer: No description available. ,
AWS_RDS: No description available. ,
AWS_AURORA: No description available. ,
AWS_EC2: No description available. ,
GCP_CloudSQL: No description available. ,
GCP_AlloyDB: No description available. ,
GCP_Compute: No description available. ,
EDB: No description available. ,
EDB_Oracle_Server: No description available. ,
EDB_PostgreSQL: No description available. ,
PostgreSQLFlexibleServer: No description available. ,
PostgreSQLCosmosDB: No description available. ,
Huawei_RDS: No description available. ,
Huawei_Compute: No description available. ,
Heroku_PostgreSQL: No description available. ,
Crunchy_PostgreSQL: No description available. ,
ApsaraDB_RDS: No description available. ,
Digital_Ocean_Droplets: No description available. ,
Digital_Ocean_PostgreSQL: No description available. ,
Supabase_PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types ,
Enum:
{
Prefer: No description available. ,
Require: No description available. ,
VerifyCA: No description available. ,
VerifyFull: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of the source database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of the target database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: ResourceId of the source database server ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters ,
Required: False ,
}
{
adminCredentials:
{
Description: Admin credentials for source and target servers ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the username for the source server. This user need not be an admin. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the username for the target server. This user need not be an admin. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Number of databases to migrate ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup LogicalReplicationOnSourceDb, if needed ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: To migrate roles and permissions we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates whether the data migration should start right away ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: To trigger cutover for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: To trigger cancel for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases send cancel flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Migration resource properties. ,
Required: False ,
}
{
migrationId:
{
Description: ID for migration, a GUID. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of migration ,
Required: False ,
}
{
state:
{
Description: State of migration ,
Enum:
{
InProgress: No description available. ,
WaitingForUserAction: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ValidationFailed: No description available. ,
CleaningUp: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error message, if any, for the migration state ,
Required: False ,
}
string ,
currentSubStateDetails:
{
Description: Current Migration sub state details. ,
Required: False ,
}
{
currentSubState:
{
Description: Migration sub state. ,
Enum:
{
PerformingPreRequisiteSteps: No description available. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: No description available. ,
WaitingForDBsToMigrateSpecification: No description available. ,
WaitingForTargetDBOverwriteConfirmation: No description available. ,
WaitingForDataMigrationScheduling: No description available. ,
WaitingForDataMigrationWindow: No description available. ,
MigratingData: No description available. ,
WaitingForCutoverTrigger: No description available. ,
CompletingMigration: No description available. ,
Completed: No description available. ,
CancelingRequestedDBMigrations: No description available. ,
ValidationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
dbDetails:
{
Required: False ,
}
object ,
validationDetails:
{
Description: Details for the validation for migration ,
Required: False ,
}
{
status:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Validation Start date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: Validation End date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
serverLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
startedOn:
{
Description: Start date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of database level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: ResourceId of the private endpoint migration instance ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: There are two types of migration modes Online and Offline ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: This indicates the supported Migration option for the migration ,
Enum:
{
Validate: No description available. ,
Migrate: No description available. ,
ValidateAndMigrate: No description available. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
AzureVM: No description available. ,
PostgreSQLSingleServer: No description available. ,
AWS_RDS: No description available. ,
AWS_AURORA: No description available. ,
AWS_EC2: No description available. ,
GCP_CloudSQL: No description available. ,
GCP_AlloyDB: No description available. ,
GCP_Compute: No description available. ,
EDB: No description available. ,
EDB_Oracle_Server: No description available. ,
EDB_PostgreSQL: No description available. ,
PostgreSQLFlexibleServer: No description available. ,
PostgreSQLCosmosDB: No description available. ,
Huawei_RDS: No description available. ,
Huawei_Compute: No description available. ,
Heroku_PostgreSQL: No description available. ,
Crunchy_PostgreSQL: No description available. ,
ApsaraDB_RDS: No description available. ,
Digital_Ocean_Droplets: No description available. ,
Digital_Ocean_PostgreSQL: No description available. ,
Supabase_PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types ,
Enum:
{
Prefer: No description available. ,
Require: No description available. ,
VerifyCA: No description available. ,
VerifyFull: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of the source database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of the target database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: ResourceId of the source database server ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters ,
Required: False ,
}
{
adminCredentials:
{
Description: Admin credentials for source and target servers ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the username for the source server. This user need not be an admin. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the username for the target server. This user need not be an admin. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Number of databases to migrate ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup LogicalReplicationOnSourceDb, if needed ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: To migrate roles and permissions we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates whether the data migration should start right away ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: To trigger cutover for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: To trigger cancel for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases send cancel flag as True and database names in this array ,
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 ,
}
,
]
,
}
,
}
Migrations_Get (new)
Description :  Gets details of a migration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID of the target database server. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the target database server. ,
Required: True ,
}
string ,
targetDbServerName:
{
Description: The name of the target database server. ,
Required: True ,
}
string ,
migrationName:
{
Description: The name of the migration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Migration resource properties. ,
Required: False ,
}
{
migrationId:
{
Description: ID for migration, a GUID. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of migration ,
Required: False ,
}
{
state:
{
Description: State of migration ,
Enum:
{
InProgress: No description available. ,
WaitingForUserAction: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ValidationFailed: No description available. ,
CleaningUp: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error message, if any, for the migration state ,
Required: False ,
}
string ,
currentSubStateDetails:
{
Description: Current Migration sub state details. ,
Required: False ,
}
{
currentSubState:
{
Description: Migration sub state. ,
Enum:
{
PerformingPreRequisiteSteps: No description available. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: No description available. ,
WaitingForDBsToMigrateSpecification: No description available. ,
WaitingForTargetDBOverwriteConfirmation: No description available. ,
WaitingForDataMigrationScheduling: No description available. ,
WaitingForDataMigrationWindow: No description available. ,
MigratingData: No description available. ,
WaitingForCutoverTrigger: No description available. ,
CompletingMigration: No description available. ,
Completed: No description available. ,
CancelingRequestedDBMigrations: No description available. ,
ValidationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
dbDetails:
{
Required: False ,
}
object ,
validationDetails:
{
Description: Details for the validation for migration ,
Required: False ,
}
{
status:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Validation Start date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: Validation End date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
serverLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
startedOn:
{
Description: Start date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of database level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: ResourceId of the private endpoint migration instance ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: There are two types of migration modes Online and Offline ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: This indicates the supported Migration option for the migration ,
Enum:
{
Validate: No description available. ,
Migrate: No description available. ,
ValidateAndMigrate: No description available. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
AzureVM: No description available. ,
PostgreSQLSingleServer: No description available. ,
AWS_RDS: No description available. ,
AWS_AURORA: No description available. ,
AWS_EC2: No description available. ,
GCP_CloudSQL: No description available. ,
GCP_AlloyDB: No description available. ,
GCP_Compute: No description available. ,
EDB: No description available. ,
EDB_Oracle_Server: No description available. ,
EDB_PostgreSQL: No description available. ,
PostgreSQLFlexibleServer: No description available. ,
PostgreSQLCosmosDB: No description available. ,
Huawei_RDS: No description available. ,
Huawei_Compute: No description available. ,
Heroku_PostgreSQL: No description available. ,
Crunchy_PostgreSQL: No description available. ,
ApsaraDB_RDS: No description available. ,
Digital_Ocean_Droplets: No description available. ,
Digital_Ocean_PostgreSQL: No description available. ,
Supabase_PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types ,
Enum:
{
Prefer: No description available. ,
Require: No description available. ,
VerifyCA: No description available. ,
VerifyFull: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of the source database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of the target database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: ResourceId of the source database server ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters ,
Required: False ,
}
{
adminCredentials:
{
Description: Admin credentials for source and target servers ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the username for the source server. This user need not be an admin. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the username for the target server. This user need not be an admin. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Number of databases to migrate ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup LogicalReplicationOnSourceDb, if needed ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: To migrate roles and permissions we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates whether the data migration should start right away ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: To trigger cutover for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: To trigger cancel for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases send cancel flag as True and database names in this array ,
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 ,
}
,
]
,
}
,
}
Migrations_Update (new)
Description :  Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID of the target database server. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the target database server. ,
Required: True ,
}
string ,
targetDbServerName:
{
Description: The name of the target database server. ,
Required: True ,
}
string ,
migrationName:
{
Description: The name of the migration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a migration. ,
Required: True ,
}
{
properties:
{
Description: Migration resource properties. ,
Required: False ,
}
{
sourceDbServerResourceId:
{
Description: ResourceId of the source database server ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters ,
Required: False ,
}
{
adminCredentials:
{
Description: Admin credentials for source and target servers ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the username for the source server. This user need not be an admin. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the username for the target server. This user need not be an admin. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Number of databases to migrate ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup LogicalReplicationOnSourceDb, if needed ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: To migrate roles and permissions we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates whether the data migration should start right away ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: To trigger cutover for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: To trigger cancel for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases send cancel flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
migrationMode:
{
Description: There are two types of migration modes Online and Offline ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Migration resource properties. ,
Required: False ,
}
{
migrationId:
{
Description: ID for migration, a GUID. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of migration ,
Required: False ,
}
{
state:
{
Description: State of migration ,
Enum:
{
InProgress: No description available. ,
WaitingForUserAction: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ValidationFailed: No description available. ,
CleaningUp: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error message, if any, for the migration state ,
Required: False ,
}
string ,
currentSubStateDetails:
{
Description: Current Migration sub state details. ,
Required: False ,
}
{
currentSubState:
{
Description: Migration sub state. ,
Enum:
{
PerformingPreRequisiteSteps: No description available. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: No description available. ,
WaitingForDBsToMigrateSpecification: No description available. ,
WaitingForTargetDBOverwriteConfirmation: No description available. ,
WaitingForDataMigrationScheduling: No description available. ,
WaitingForDataMigrationWindow: No description available. ,
MigratingData: No description available. ,
WaitingForCutoverTrigger: No description available. ,
CompletingMigration: No description available. ,
Completed: No description available. ,
CancelingRequestedDBMigrations: No description available. ,
ValidationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
dbDetails:
{
Required: False ,
}
object ,
validationDetails:
{
Description: Details for the validation for migration ,
Required: False ,
}
{
status:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Validation Start date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: Validation End date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
serverLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
startedOn:
{
Description: Start date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of database level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: ResourceId of the private endpoint migration instance ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: There are two types of migration modes Online and Offline ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: This indicates the supported Migration option for the migration ,
Enum:
{
Validate: No description available. ,
Migrate: No description available. ,
ValidateAndMigrate: No description available. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
AzureVM: No description available. ,
PostgreSQLSingleServer: No description available. ,
AWS_RDS: No description available. ,
AWS_AURORA: No description available. ,
AWS_EC2: No description available. ,
GCP_CloudSQL: No description available. ,
GCP_AlloyDB: No description available. ,
GCP_Compute: No description available. ,
EDB: No description available. ,
EDB_Oracle_Server: No description available. ,
EDB_PostgreSQL: No description available. ,
PostgreSQLFlexibleServer: No description available. ,
PostgreSQLCosmosDB: No description available. ,
Huawei_RDS: No description available. ,
Huawei_Compute: No description available. ,
Heroku_PostgreSQL: No description available. ,
Crunchy_PostgreSQL: No description available. ,
ApsaraDB_RDS: No description available. ,
Digital_Ocean_Droplets: No description available. ,
Digital_Ocean_PostgreSQL: No description available. ,
Supabase_PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types ,
Enum:
{
Prefer: No description available. ,
Require: No description available. ,
VerifyCA: No description available. ,
VerifyFull: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of the source database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of the target database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: ResourceId of the source database server ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters ,
Required: False ,
}
{
adminCredentials:
{
Description: Admin credentials for source and target servers ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the username for the source server. This user need not be an admin. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the username for the target server. This user need not be an admin. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Number of databases to migrate ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup LogicalReplicationOnSourceDb, if needed ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: To migrate roles and permissions we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates whether the data migration should start right away ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: To trigger cutover for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: To trigger cancel for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases send cancel flag as True and database names in this array ,
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 ,
}
,
]
,
}
,
}
Migrations_Delete (new)
Description :  Deletes a migration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID of the target database server. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the target database server. ,
Required: True ,
}
string ,
targetDbServerName:
{
Description: The name of the target database server. ,
Required: True ,
}
string ,
migrationName:
{
Description: The name of the migration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Migrations_ListByTargetServer (new)
Description :  List all the migrations on a given target server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID of the target database server. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the target database server. ,
Required: True ,
}
string ,
targetDbServerName:
{
Description: The name of the target database server. ,
Required: True ,
}
string ,
migrationListFilter:
{
Description: Migration list filter. Retrieves either active migrations or all migrations. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of migration resources. ,
Required: False ,
}
[
{
properties:
{
Description: Migration resource properties. ,
Required: False ,
}
{
migrationId:
{
Description: ID for migration, a GUID. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of migration ,
Required: False ,
}
{
state:
{
Description: State of migration ,
Enum:
{
InProgress: No description available. ,
WaitingForUserAction: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ValidationFailed: No description available. ,
CleaningUp: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error message, if any, for the migration state ,
Required: False ,
}
string ,
currentSubStateDetails:
{
Description: Current Migration sub state details. ,
Required: False ,
}
{
currentSubState:
{
Description: Migration sub state. ,
Enum:
{
PerformingPreRequisiteSteps: No description available. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: No description available. ,
WaitingForDBsToMigrateSpecification: No description available. ,
WaitingForTargetDBOverwriteConfirmation: No description available. ,
WaitingForDataMigrationScheduling: No description available. ,
WaitingForDataMigrationWindow: No description available. ,
MigratingData: No description available. ,
WaitingForCutoverTrigger: No description available. ,
CompletingMigration: No description available. ,
Completed: No description available. ,
CancelingRequestedDBMigrations: No description available. ,
ValidationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
dbDetails:
{
Required: False ,
}
object ,
validationDetails:
{
Description: Details for the validation for migration ,
Required: False ,
}
{
status:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Validation Start date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: Validation End date-time in UTC ,
Format: date-time ,
Required: False ,
}
string ,
serverLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
startedOn:
{
Description: Start date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End date-time of a database level validation ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of database level validations ,
Required: False ,
}
[
{
type:
{
Description: Validation type ,
Required: False ,
}
string ,
state:
{
Description: Validation status for migration ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: ResourceId of the private endpoint migration instance ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: There are two types of migration modes Online and Offline ,
Enum:
{
Offline: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: This indicates the supported Migration option for the migration ,
Enum:
{
Validate: No description available. ,
Migrate: No description available. ,
ValidateAndMigrate: No description available. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
AzureVM: No description available. ,
PostgreSQLSingleServer: No description available. ,
AWS_RDS: No description available. ,
AWS_AURORA: No description available. ,
AWS_EC2: No description available. ,
GCP_CloudSQL: No description available. ,
GCP_AlloyDB: No description available. ,
GCP_Compute: No description available. ,
EDB: No description available. ,
EDB_Oracle_Server: No description available. ,
EDB_PostgreSQL: No description available. ,
PostgreSQLFlexibleServer: No description available. ,
PostgreSQLCosmosDB: No description available. ,
Huawei_RDS: No description available. ,
Huawei_Compute: No description available. ,
Heroku_PostgreSQL: No description available. ,
Crunchy_PostgreSQL: No description available. ,
ApsaraDB_RDS: No description available. ,
Digital_Ocean_Droplets: No description available. ,
Digital_Ocean_PostgreSQL: No description available. ,
Supabase_PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types ,
Enum:
{
Prefer: No description available. ,
Require: No description available. ,
VerifyCA: No description available. ,
VerifyFull: No description available. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of the source database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of the target database server ,
Required: False ,
}
{
location:
{
Description: Location of database server ,
Required: False ,
}
string ,
version:
{
Description: Version for database engine ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size in MB for database server ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: SKU for the database server. This object is empty for PG single server ,
Required: False ,
}
{
name:
{
Description: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. ,
Required: False ,
}
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: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: ResourceId of the source database server ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters ,
Required: False ,
}
{
adminCredentials:
{
Description: Admin credentials for source and target servers ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the username for the source server. This user need not be an admin. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the username for the target server. This user need not be an admin. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Number of databases to migrate ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup LogicalReplicationOnSourceDb, if needed ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time in UTC for migration window ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: To migrate roles and permissions we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates whether the data migration should start right away ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: To trigger cutover for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: To trigger cancel for entire migration we need to send this flag as True ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases send cancel flag as True and database names in this array ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of migrations. ,
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 ,
}
,
]
,
}
,
}
CheckMigrationNameAvailability (new)
Description :  This method checks whether a proposed migration name is valid and available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/checkMigrationNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID of the target database server. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name of the target database server. ,
Required: True ,
}
string ,
targetDbServerName:
{
Description: The name of the target database server. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for checking if a migration name is available. ,
Required: True ,
}
{
name:
{
Description: The resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
nameAvailable:
{
Description: Indicates whether the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: Migration name availability reason ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Migration name availability message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: The resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
nameAvailable:
{
Description: Indicates whether the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: Migration name availability reason ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Migration name availability message. ,
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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DBforPostgreSQL/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of available operation details ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: False ,
}
string ,
display:
{
Description: The localized display information for this particular operation or action. ,
Required: False ,
}
{
provider:
{
Description: Operation resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: Operation description. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
origin:
{
Description: The intended executor of the operation. ,
Enum:
{
NotSpecified: No description available. ,
user: No description available. ,
system: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
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 ,
}
,
]
,
}
,
}
GetPrivateDnsZoneSuffix_Execute (new)
Description :  Get private DNS zone suffix in the cloud
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.DBforPostgreSQL/getPrivateDnsZoneSuffix
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents a resource name availability. ,
}
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnection_Update (new)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating private endpoint connection. ,
Required: True ,
}
{
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 ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnection_Delete (new)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByServer (new)
Description :  Gets all private endpoint connections on a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections
{
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)

{
value:
{
Description: Array of results. ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByServer (new)
Description :  Gets the private link resources for PostgreSQL server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateLinkResources
{
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)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
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 ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets a private link resource for PostgreSQL server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateLinkResources/{groupName}
{
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 ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
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 ,
}
,
]
,
}
,
}
QuotaUsages_List (new)
Description :  Get quota usages at specified location in a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/resourceType/flexibleServers/usages
{
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 ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of quota usages. ,
Required: False ,
}
[
{
name:
{
Description: Name of quota usage for flexible servers ,
Required: False ,
}
{
value:
{
Description: Name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized name ,
Required: False ,
}
string ,
}
,
limit:
{
Description: Quota limit ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Quota unit ,
Required: False ,
}
string ,
currentValue:
{
Description: Current Quota usage value ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: Fully qualified ARM resource Id ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
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 ,
}
,
]
,
}
,
}
Replicas_ListByServer (new)
Description :  List all the replicas for a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas
{
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)

{
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. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: 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 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, Microsoft Entra 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 ,
}
,
]
,
}
,
}
LogFiles_ListByServer (new)
Description :  List all the server log files in a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/logFiles
{
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)

{
value:
{
Description: The list of logFiles in a server ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a logFile. ,
Required: False ,
}
{
createdTime:
{
Description: Creation timestamp of the log file. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified timestamp of the log file. ,
Format: date-time ,
Required: False ,
}
string ,
sizeInKb:
{
Description: The size in kb of the logFile. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: Type of the log file. ,
Required: False ,
}
string ,
url:
{
Description: The url to download the log file from. ,
Required: False ,
}
string ,
}
,
}
,
]
,
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_Restart (new)
Description :  Restarts a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/restart
{
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 parameters for restarting a server. ,
Required: False ,
}
{
restartWithFailover:
{
Description: Indicates whether to restart the server with failover. ,
Required: False ,
}
boolean ,
failoverMode:
{
Description: Failover mode. ,
Enum:
{
PlannedFailover: No description available. ,
ForcedFailover: No description available. ,
PlannedSwitchover: No description available. ,
ForcedSwitchover: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ 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_Start (new)
Description :  Starts a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/start
{
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)

{}

⚐ 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_Stop (new)
Description :  Stops a server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/stop
{
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)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ServerThreatProtectionSettings_ListByServer (new)
Description :  Get a list of server's Threat Protection state.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings
{
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)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Advanced Threat Protection properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
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 ,
}
,
]
,
}
,
}
ServerThreatProtectionSettings_Get (new)
Description :  Get a server's Advanced Threat Protection settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{threatProtectionName}
{
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 ,
threatProtectionName:
{
Description: The name of the Threat Protection state. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Advanced Threat Protection properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
ServerThreatProtectionSettings_CreateOrUpdate (new)
Description :  Creates or updates a server's Advanced Threat Protection settings.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{threatProtectionName}
{
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 ,
threatProtectionName:
{
Description: The name of the Threat Protection state. ,
Required: True ,
}
string ,
parameters:
{
Description: The Advanced Threat Protection state for the flexible server. ,
Required: True ,
}
{
properties:
{
Description: Advanced Threat Protection properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Advanced Threat Protection properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Advanced Threat Protection properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}
TuningOptions_Get (new)
Description :  Retrieve the tuning option on a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}
{
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 ,
tuningOption:
{
Description: The name of the tuning option. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Stores property that features impact on some metric if this recommended action is applied. ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
TuningIndex_ListRecommendations (new)
Description :  Retrieve the list of available tuning index recommendations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/recommendations
{
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 ,
tuningOption:
{
Description: The name of the tuning option. ,
Required: True ,
}
string ,
recommendationType:
{
Description: Recommendations list filter. Retrieves recommendations based on type. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of available index recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of IndexRecommendationResource. ,
Required: False ,
}
{
initialRecommendedTime:
{
Description: Creation time of this recommendation in UTC date-time string format. ,
Format: date-time ,
Required: False ,
}
string ,
lastRecommendedTime:
{
Description: The last refresh of this recommendation in UTC date-time string format. ,
Format: date-time ,
Required: False ,
}
string ,
timesRecommended:
{
Description: The number of times this recommendation has encountered. ,
Format: int32 ,
Required: False ,
}
integer ,
improvedQueryIds:
{
Description: The ImprovedQueryIds. The list will only be populated for CREATE INDEX recommendations. ,
Required: False ,
}
[
integer ,
]
,
recommendationReason:
{
Description: Reason for this recommendation. ,
Required: False ,
}
string ,
recommendationType:
{
Description: Type for this recommendation. ,
Enum:
{
CreateIndex: No description available. ,
DropIndex: No description available. ,
ReIndex: No description available. ,
}
,
Required: False ,
}
enum ,
implementationDetails:
{
Description: Stores implementation details for the recommended action. ,
Required: False ,
}
{
method:
{
Description: Method of implementation for recommended action ,
Required: False ,
}
string ,
script:
{
Description: Implementation script for the recommended action ,
Required: False ,
}
string ,
}
,
analyzedWorkload:
{
Description: Stores workload information for the recommended action. ,
Required: False ,
}
{
startTime:
{
Description: Workload start time in UTC date-time string format. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Workload end time in UTC date-time string format. ,
Format: date-time ,
Required: False ,
}
string ,
queryCount:
{
Description: Workload query examined count. For DROP INDEX will be 0. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
estimatedImpact:
{
Description: The estimated impact of this recommended action ,
Required: False ,
}
[
{
dimensionName:
{
Description: Dimension name ,
Required: False ,
}
string ,
unit:
{
Description: Dimension unit ,
Required: False ,
}
string ,
queryId:
{
Description: Optional property that can be used to store the QueryId if the metric is for a specific query. ,
Format: int64 ,
Required: False ,
}
integer ,
absoluteValue:
{
Description: Absolute value ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
details:
{
Description: Stores recommendation details for the recommended action. ,
Required: False ,
}
{
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
schema:
{
Description: Schema name. ,
Required: False ,
}
string ,
table:
{
Description: Table name. ,
Required: False ,
}
string ,
indexType:
{
Description: Index type. ,
Required: False ,
}
string ,
indexName:
{
Description: Index name. ,
Required: False ,
}
string ,
indexColumns:
{
Description: Index columns. ,
Required: False ,
}
[
string ,
]
,
includedColumns:
{
Description: Index included columns. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
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 ,
}
,
]
,
}
,
}
TuningConfiguration_Enable (new)
Description :  Enables the config tuning.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/enable
{
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 ,
tuningOption:
{
Description: The name of the tuning option. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
TuningConfiguration_Disable (new)
Description :  Disables the config tuning.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/disable
{
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 ,
tuningOption:
{
Description: The name of the tuning option. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
TuningConfiguration_StartSession (new)
Description :  Starts up the config tuning session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/startSession
{
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 ,
tuningOption:
{
Description: The name of the tuning option. ,
Required: True ,
}
string ,
configTuningRequest:
{
Description: The parameters for tuning request. ,
Required: True ,
}
{
serverName:
{
Description: The name of server. ,
Required: False ,
}
string ,
allowServerRestarts:
{
Description: Indicates whether PG should be restarted during a tuning session. ,
Required: False ,
}
boolean ,
targetImprovementMetric:
{
Description: The target metric the tuning session is trying to improve. ,
Required: False ,
}
string ,
configTuningUsageMode:
{
Description: The mode with which the feature will be enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
TuningConfiguration_StopSession (new)
Description :  Stops the config tuning session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/stopSession
{
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 ,
tuningOption:
{
Description: The name of the tuning option. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
TuningConfiguration_ListSessions (new)
Description :  Gets up the config tuning session status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/sessions
{
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 ,
tuningOption:
{
Description: The name of the tuning option. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of tuning configuration sessions. ,
Required: False ,
}
[
{
sessionStartTime:
{
Description: the tuning session start time. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session id. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tuning session. ,
Required: False ,
}
string ,
preTuningAqr:
{
Description: The pre tuning aqr. ,
Required: False ,
}
string ,
postTuningAqr:
{
Description: The post tuning aqr. ,
Required: False ,
}
string ,
preTuningTps:
{
Description: The pre tuning tps. ,
Required: False ,
}
string ,
postTuningTps:
{
Description: The post tuning tps. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
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 ,
}
,
]
,
}
,
}
TuningConfiguration_ListSessionDetails (new)
Description :  Gets the session details of a config tuning session.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/sessionDetails
{
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 ,
tuningOption:
{
Description: The name of the tuning option. ,
Required: True ,
}
string ,
sessionId:
{
Description: Guid of the objectId for the session. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of details of the session. ,
Required: False ,
}
[
{
iterationId:
{
Description: Iteration id. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session id. ,
Required: False ,
}
string ,
appliedConfiguration:
{
Description: Applied configuration for the iteration. ,
Required: False ,
}
string ,
iterationStartTime:
{
Description: Iteration start time. ,
Required: False ,
}
string ,
averageQueryRuntimeMs:
{
Description: The aqr for the iteration. ,
Required: False ,
}
string ,
transactionsPerSecond:
{
Description: The tps for the iteration. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
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 ,
}
,
]
,
}
,
}
TuningOptions_ListByServer (new)
Description :  Retrieve the list of available tuning options.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions
{
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)

{
value:
{
Description: A list of available tuning options. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
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 ,
}
,
]
,
}
,
}
VirtualEndpoints_Create (new)
Description :  Creates a new virtual endpoint for PostgreSQL flexible server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
{
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 ,
virtualEndpointName:
{
Description: The name of the virtual endpoint. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating virtual endpoints. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents a virtual endpoint for a server. ,
}
object ,
}

⚐ Response (201)

{
$schema:
{
Description: Represents a virtual endpoint for a server. ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
VirtualEndpoints_Update (new)
Description :  Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
{
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 ,
virtualEndpointName:
{
Description: The name of the virtual endpoint. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server. ,
Required: True ,
}
{
properties:
{
Description: Properties of the virtual endpoint resource. ,
Required: False ,
}
{
endpointType:
{
Description: The endpoint type for the virtual endpoint. ,
Enum:
{
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
members:
{
Description: List of members for a virtual endpoint ,
Required: False ,
}
[
string ,
]
,
virtualEndpoints:
{
Description: List of virtual endpoints for a server ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: Represents a virtual endpoint for a server. ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
VirtualEndpoints_Delete (new)
Description :  Deletes a virtual endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
{
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 ,
virtualEndpointName:
{
Description: The name of the virtual endpoint. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
VirtualEndpoints_Get (new)
Description :  Gets information about a virtual endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
{
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 ,
virtualEndpointName:
{
Description: The name of the virtual endpoint. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents a virtual endpoint for a server. ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
VirtualEndpoints_ListByServer (new)
Description :  List all the servers in a given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints
{
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)

{
value:
{
Description: The list of virtual endpoints ,
Required: False ,
}
[
object ,
]
,
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 ,
}
,
]
,
}
,
}
VirtualNetworkSubnetUsage_Execute (new)
Description :  Get virtual network subnet usage for a given vNet resource id.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkVirtualNetworkSubnetUsage
{
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 ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a server. ,
Required: True ,
}
{
virtualNetworkArmResourceId:
{
Description: Virtual network resource id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
delegatedSubnetsUsage:
{
Required: False ,
}
[
{
subnetName:
{
Description: Name of the delegated subnet for which IP addresses are in use ,
Required: False ,
}
string ,
usage:
{
Description: Number of IP addresses used by the delegated subnet ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
location:
{
Description: location of the delegated subnet usage ,
Required: False ,
}
string ,
subscriptionId:
{
Description: subscriptionId of the delegated subnet usage ,
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 ,
}
,
]
,
}
,
}