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

2025/08/16 • 30 updated methods

AdministratorsMicrosoftEntra_Get (updated)
Description :  Gets information about a server administrator associated to a Microsoft Entra principal.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AdministratorsMicrosoftEntra_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "principalType",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "The principal type is not known or not specified."
                ],
                [
                  "User",
                  "A Microsoft Entra user."
                ],
                [
                  "Group",
                  "A Microsoft Entra group."
                ],
                [
                  "ServicePrincipal",
                  "A Microsoft Entra service principal, typically representing an application or service identity"
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "User",
                  ""
                ],
                [
                  "Group",
                  ""
                ],
                [
                  "ServicePrincipal",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Object identifier of the Microsoft Entra principal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a server administrator associated to a Microsoft Entra principal. ,
Required: True ,
}
{
principalType:
{
Description: Type of Microsoft Entra principal to which the server administrator is associated. ,
Enum:
{
Unknown: The principal type is not known or not specified. ,
User: A Microsoft Entra user. ,
Group: A Microsoft Entra group. ,
ServicePrincipal: A Microsoft Entra service principal, typically representing an application or service identity ,
}
,
Required: False ,
}
enum ,
principalName:
{
Description: Name of the Microsoft Entra principal. ,
Required: False ,
}
string ,
objectId:
{
Description: Object identifier of the Microsoft Entra principal. ,
Required: False ,
}
string ,
tenantId:
{
Description: Identifier of the tenant in which the Microsoft Entra principal exists. ,
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 ,
}
,
]
,
}
,
}
AdministratorsMicrosoftEntra_ListByServer (updated)
Description :  List all server administrators associated to a Microsoft Entra principal.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AdministratorsMicrosoftEntra_ListByServer",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "principalType",
                "Enum": {
                  "new": [
                    [
                      "Unknown",
                      "The principal type is not known or not specified."
                    ],
                    [
                      "User",
                      "A Microsoft Entra user."
                    ],
                    [
                      "Group",
                      "A Microsoft Entra group."
                    ],
                    [
                      "ServicePrincipal",
                      "A Microsoft Entra service principal, typically representing an application or service identity"
                    ]
                  ],
                  "old": [
                    [
                      "Unknown",
                      ""
                    ],
                    [
                      "User",
                      ""
                    ],
                    [
                      "Group",
                      ""
                    ],
                    [
                      "ServicePrincipal",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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: List of server administrators associated to Microsoft Entra principals. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a server administrator associated to a Microsoft Entra principal. ,
Required: True ,
}
{
principalType:
{
Description: Type of Microsoft Entra principal to which the server administrator is associated. ,
Enum:
{
Unknown: The principal type is not known or not specified. ,
User: A Microsoft Entra user. ,
Group: A Microsoft Entra group. ,
ServicePrincipal: A Microsoft Entra service principal, typically representing an application or service identity ,
}
,
Required: False ,
}
enum ,
principalName:
{
Description: Name of the Microsoft Entra principal. ,
Required: False ,
}
string ,
objectId:
{
Description: Object identifier of the Microsoft Entra principal. ,
Required: False ,
}
string ,
tenantId:
{
Description: Identifier of the tenant in which the Microsoft Entra principal exists. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link used to get the next page 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 ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_ListByServer (updated)
Description :  Lists state of advanced threat protection settings for a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AdvancedThreatProtectionSettings_ListByServer",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Advanced threat protection is enabled."
                    ],
                    [
                      "Disabled",
                      "Advanced threat protection is disabled."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the server. ,
Enum:
{
Enabled: Advanced threat protection is enabled. ,
Disabled: Advanced threat protection is disabled. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the creation time (UTC) of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link used to get the next page 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 ,
}
,
]
,
}
,
}
AdvancedThreatProtectionSettings_Get (updated)
Description :  Gets state of advanced threat protection settings for a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AdvancedThreatProtectionSettings_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "state",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "Advanced threat protection is enabled."
                ],
                [
                  "Disabled",
                  "Advanced threat protection is disabled."
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Name of the advanced threat protection settings. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚶ Changes

{
  "#id": "ServerThreatProtectionSettings_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "state",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "Advanced threat protection is enabled."
                ],
                [
                  "Disabled",
                  "Advanced threat protection is disabled."
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Name of the advanced threat protection settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The Advanced Threat Protection state for the server. ,
Required: True ,
}
{
properties:
{
Description: Advanced threat protection properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the server. ,
Enum:
{
Enabled: Advanced threat protection is enabled. ,
Disabled: Advanced threat protection is disabled. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the creation time (UTC) of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: 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 ,
}
,
]
,
}
,
}
BackupsAutomaticAndOnDemand_Get (updated)
Description :  Gets information of an on demand backup, given its name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupsAutomaticAndOnDemand_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "backupType",
            "Enum": {
              "new": [
                [
                  "Full",
                  "A full backup taken automatically by the service. These backups are retained for a period of time as defined by the backup retention policy, and they cannot be deleted by the customer."
                ],
                [
                  "Customer On-Demand",
                  "A full backup triggered by the customer. These backups are retained for a period of time as defined by the backup retention policy, and they can also be deleted by the customer."
                ]
              ],
              "old": [
                [
                  "Full",
                  ""
                ],
                [
                  "Customer On-Demand",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Name of the backup. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a backup. ,
Required: False ,
}
{
backupType:
{
Description: Type of backup. ,
Enum:
{
Full: A full backup taken automatically by the service. These backups are retained for a period of time as defined by the backup retention policy, and they cannot be deleted by the customer. ,
Customer On-Demand: A full backup triggered by the customer. These backups are retained for a period of time as defined by the backup retention policy, and they can also be deleted by the customer. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Time(ISO8601 format) at which the backup was completed. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the backup. ,
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 ,
}
,
]
,
}
,
}
BackupsAutomaticAndOnDemand_ListByServer (updated)
Description :  Lists all available backups of a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupsAutomaticAndOnDemand_ListByServer",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "backupType",
                "Enum": {
                  "new": [
                    [
                      "Full",
                      "A full backup taken automatically by the service. These backups are retained for a period of time as defined by the backup retention policy, and they cannot be deleted by the customer."
                    ],
                    [
                      "Customer On-Demand",
                      "A full backup triggered by the customer. These backups are retained for a period of time as defined by the backup retention policy, and they can also be deleted by the customer."
                    ]
                  ],
                  "old": [
                    [
                      "Full",
                      ""
                    ],
                    [
                      "Customer On-Demand",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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: List of available backups. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a backup. ,
Required: False ,
}
{
backupType:
{
Description: Type of backup. ,
Enum:
{
Full: A full backup taken automatically by the service. These backups are retained for a period of time as defined by the backup retention policy, and they cannot be deleted by the customer. ,
Customer On-Demand: A full backup triggered by the customer. These backups are retained for a period of time as defined by the backup retention policy, and they can also be deleted by the customer. ,
}
,
Required: False ,
}
enum ,
completedTime:
{
Description: Time(ISO8601 format) at which the backup was completed. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: Source of the backup. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link used to get the next page 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 ,
}
,
]
,
}
,
}
BackupsLongTermRetention_Start (updated)
Description :  Initiates a long term retention backup.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupsLongTermRetention_Start",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "status",
            "Enum": {
              "new": [
                [
                  "Running",
                  "The operation is currently running."
                ],
                [
                  "Cancelled",
                  "The operation was cancelled."
                ],
                [
                  "Failed",
                  "The operation failed."
                ],
                [
                  "Succeeded",
                  "The operation succeeded."
                ]
              ],
              "old": [
                [
                  "Running",
                  ""
                ],
                [
                  "Cancelled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: The operation is currently running. ,
Cancelled: The operation was cancelled. ,
Failed: The operation failed. ,
Succeeded: The operation succeeded. ,
}
,
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 ,
}
,
]
,
}
,
}
,
}
BackupsLongTermRetention_Get (updated)
Description :  Gets the results of a long retention backup operation for a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupsLongTermRetention_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "status",
            "Enum": {
              "new": [
                [
                  "Running",
                  "The operation is currently running."
                ],
                [
                  "Cancelled",
                  "The operation was cancelled."
                ],
                [
                  "Failed",
                  "The operation failed."
                ],
                [
                  "Succeeded",
                  "The operation succeeded."
                ]
              ],
              "old": [
                [
                  "Running",
                  ""
                ],
                [
                  "Cancelled",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: The operation is currently running. ,
Cancelled: The operation was cancelled. ,
Failed: The operation failed. ,
Succeeded: The operation succeeded. ,
}
,
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 ,
}
,
]
,
}
,
}
BackupsLongTermRetention_ListByServer (updated)
Description :  Lists the results of the long term retention backup operations for a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupsLongTermRetention_ListByServer",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "status",
                "Enum": {
                  "new": [
                    [
                      "Running",
                      "The operation is currently running."
                    ],
                    [
                      "Cancelled",
                      "The operation was cancelled."
                    ],
                    [
                      "Failed",
                      "The operation failed."
                    ],
                    [
                      "Succeeded",
                      "The operation succeeded."
                    ]
                  ],
                  "old": [
                    [
                      "Running",
                      ""
                    ],
                    [
                      "Cancelled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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: The operation is currently running. ,
Cancelled: The operation was cancelled. ,
Failed: The operation failed. ,
Succeeded: The operation succeeded. ,
}
,
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. ,
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 ,
}
,
]
,
}
,
}
CapabilitiesByLocation_List (updated)
Description :  Lists the capabilities available in a given location for a specific subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CapabilitiesByLocation_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "supportedServerEditions": {
                "$properties": {
                  "supportedServerSkus": {
                    "$properties": {
                      "supportedHaMode": {
                        "Enum": {
                          "new": [
                            [
                              "SameZone",
                              "High availability is enabled for the server, with standby server in the same availability zone as the primary."
                            ],
                            [
                              "ZoneRedundant",
                              "High availability is enabled for the server, with standby server in a different availability zone than that of the primary."
                            ]
                          ],
                          "old": [
                            [
                              "SameZone",
                              ""
                            ],
                            [
                              "ZoneRedundant",
                              ""
                            ]
                          ]
                        }
                      },
                      "supportedFeatures": {
                        "$properties": [
                          {
                            "#name": "status",
                            "Enum": {
                              "new": [
                                [
                                  "Enabled",
                                  "Feature is enabled."
                                ],
                                [
                                  "Disabled",
                                  "Feature is disabled."
                                ]
                              ],
                              "old": [
                                [
                                  "Enabled",
                                  ""
                                ],
                                [
                                  "Disabled",
                                  ""
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              }
            },
            {
              "supportedServerVersions": {
                "$properties": {
                  "supportedFeatures": {
                    "$properties": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Enabled",
                              "Feature is enabled."
                            ],
                            [
                              "Disabled",
                              "Feature is disabled."
                            ]
                          ],
                          "old": [
                            [
                              "Enabled",
                              ""
                            ],
                            [
                              "Disabled",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  }
                }
              }
            },
            {
              "supportedFeatures": {
                "$properties": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Feature is enabled."
                        ],
                        [
                          "Disabled",
                          "Feature is disabled."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "fastProvisioningSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Fast provisioning is supported."
                  ],
                  [
                    "Disabled",
                    "Fast provisioning is not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "geoBackupSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Geographically redundant backups are supported."
                  ],
                  [
                    "Disabled",
                    "Geographically redundant backups are not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "zoneRedundantHaSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "High availability with zone redundancy is supported."
                  ],
                  [
                    "Disabled",
                    "High availability with zone redundancy is not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "zoneRedundantHaAndGeoBackupSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "High availability with zone redundancy is supported in conjunction with geographically redundant backups."
                  ],
                  [
                    "Disabled",
                    "High availability with zone redundancy is not supported in conjunction with geographically redundant backups."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "storageAutoGrowthSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Storage autogrow is supported."
                  ],
                  [
                    "Disabled",
                    "Storage autogrow is not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "onlineResizeSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Resizing the storage without interrupting the operation of the database engine is supported."
                  ],
                  [
                    "Disabled",
                    "Resizing the storage without interrupting the operation of the database engine is not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "restricted",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Location is restricted."
                  ],
                  [
                    "Disabled",
                    "Location is not restricted."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ 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: List of supported capabilities. ,
Required: False ,
}
[
{
name:
{
Description: Name of flexible servers capabilities. ,
Required: False ,
}
string ,
supportedServerEditions:
{
Description: List of supported compute tiers. ,
Required: False ,
}
[
{
name:
{
Description: Name of compute tier. ,
Required: False ,
}
string ,
defaultSkuName:
{
Description: Default compute name (SKU) for this computer tier. ,
Required: False ,
}
string ,
supportedStorageEditions:
{
Description: List of storage editions supported by this compute tier and compute name. ,
Required: False ,
}
[
{
name:
{
Description: Name of storage tier. ,
Required: False ,
}
string ,
defaultStorageSizeMb:
{
Description: Default storage size (in MB) for this storage tier. ,
Format: int64 ,
Required: False ,
}
integer ,
supportedStorageMb:
{
Description: Configurations of storage supported for this storage tier. ,
Required: False ,
}
[
{
supportedIops:
{
Description: Minimum IOPS supported by the storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMaximumIops:
{
Description: Maximum IOPS supported by the storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeMb:
{
Description: Minimum supported size (in MB) of storage. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumStorageSizeMb:
{
Description: Maximum supported size (in MB) of storage. ,
Format: int64 ,
Required: False ,
}
integer ,
supportedThroughput:
{
Description: Minimum supported throughput (in MB/s) of storage. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMaximumThroughput:
{
Description: Maximum supported throughput (in MB/s) of storage. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultIopsTier:
{
Description: Default IOPS for this tier and storage size. ,
Required: False ,
}
string ,
supportedIopsTiers:
{
Description: List of all supported storage tiers for this tier and storage size. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage tier. ,
Required: False ,
}
string ,
iops:
{
Description: Supported IOPS for the storage tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
supportedServerSkus:
{
Description: List of supported compute names (SKUs). ,
Required: False ,
}
[
{
name:
{
Description: Name of the compute (SKU). ,
Required: False ,
}
string ,
vCores:
{
Description: vCores available for this compute. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedIops:
{
Description: Maximum IOPS supported by this compute. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMemoryPerVcoreMb:
{
Description: Supported memory (in MB) per virtual core assigned to this compute. ,
Format: int64 ,
Required: False ,
}
integer ,
supportedZones:
{
Description: List of supported availability zones. E.g. '1', '2', '3' ,
Required: False ,
}
[
string ,
]
,
supportedHaMode:
{
Description: Modes of high availability supported for this compute. ,
Required: False ,
}
[
string ,
]
,
supportedFeatures:
{
Description: Features supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the feature. ,
Required: False ,
}
string ,
status:
{
Description: Status of the feature. Indicates if the feature is enabled or not. ,
Enum:
{
Enabled: Feature is enabled. ,
Disabled: Feature is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
securityProfile:
{
Description: Security profile of the compute. Indicates if it's a Confidential Compute virtual machine. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
supportedServerVersions:
{
Description: List of supported major versions of PostgreSQL database engine. ,
Required: False ,
}
[
{
name:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
supportedVersionsToUpgrade:
{
Description: Major versions of PostgreSQL database engine to which this version can be automatically upgraded. ,
Required: False ,
}
[
string ,
]
,
supportedFeatures:
{
Description: Features supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the feature. ,
Required: False ,
}
string ,
status:
{
Description: Status of the feature. Indicates if the feature is enabled or not. ,
Enum:
{
Enabled: Feature is enabled. ,
Disabled: Feature is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
supportedFeatures:
{
Description: Features supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the feature. ,
Required: False ,
}
string ,
status:
{
Description: Status of the feature. Indicates if the feature is enabled or not. ,
Enum:
{
Enabled: Feature is enabled. ,
Disabled: Feature is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
fastProvisioningSupported:
{
Description: Indicates if fast provisioning is supported. 'Enabled' means fast provisioning is supported. 'Disabled' stands for fast provisioning is not supported. Will be deprecated in the future. Look to Supported Features for 'FastProvisioning'. ,
Enum:
{
Enabled: Fast provisioning is supported. ,
Disabled: Fast provisioning is not supported. ,
}
,
Required: False ,
}
enum ,
supportedFastProvisioningEditions:
{
Description: List of compute tiers supporting fast provisioning. ,
Required: False ,
}
[
{
supportedTier:
{
Description: Compute tier supporting fast provisioning. ,
Required: False ,
}
string ,
supportedSku:
{
Description: Compute name (SKU) supporting fast provisioning. ,
Required: False ,
}
string ,
supportedStorageGb:
{
Description: Storage size (in GB) supporting fast provisioning. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedServerVersions:
{
Description: Major version of PostgreSQL database engine supporting fast provisioning. ,
Required: False ,
}
string ,
serverCount:
{
Description: Count of servers in cache matching this specification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
geoBackupSupported:
{
Description: Indicates if geographically redundant backups are supported in this location. 'Enabled' means geographically redundant backups are supported. 'Disabled' stands for geographically redundant backup is not supported. Will be deprecated in the future. Look to Supported Features for 'GeoBackup'. ,
Enum:
{
Enabled: Geographically redundant backups are supported. ,
Disabled: Geographically redundant backups are not supported. ,
}
,
Required: False ,
}
enum ,
zoneRedundantHaSupported:
{
Description: Indicates if high availability with zone redundancy is supported in this location. 'Enabled' means high availability with zone redundancy is supported. 'Disabled' stands for high availability with zone redundancy is not supported. Will be deprecated in the future. Look to Supported Features for 'ZoneRedundantHa'. ,
Enum:
{
Enabled: High availability with zone redundancy is supported. ,
Disabled: High availability with zone redundancy is not supported. ,
}
,
Required: False ,
}
enum ,
zoneRedundantHaAndGeoBackupSupported:
{
Description: Indicates if high availability with zone redundancy is supported in conjunction with geographically redundant backups in this location. 'Enabled' means high availability with zone redundancy is supported in conjunction with geographically redundant backups is supported. 'Disabled' stands for high availability with zone redundancy is supported in conjunction with geographically redundant backups is not supported. Will be deprecated in the future. Look to Supported Features for 'ZoneRedundantHaAndGeoBackup'. ,
Enum:
{
Enabled: High availability with zone redundancy is supported in conjunction with geographically redundant backups. ,
Disabled: High availability with zone redundancy is not supported in conjunction with geographically redundant backups. ,
}
,
Required: False ,
}
enum ,
storageAutoGrowthSupported:
{
Description: Indicates if storage autogrow is supported in this location. 'Enabled' means storage autogrow is supported. 'Disabled' stands for storage autogrow is not supported. Will be deprecated in the future. Look to Supported Features for 'StorageAutoGrowth'. ,
Enum:
{
Enabled: Storage autogrow is supported. ,
Disabled: Storage autogrow is not supported. ,
}
,
Required: False ,
}
enum ,
onlineResizeSupported:
{
Description: Indicates if resizing the storage, without interrupting the operation of the database engine, is supported in this location for the given subscription. 'Enabled' means resizing the storage without interrupting the operation of the database engine is supported. 'Disabled' means resizing the storage without interrupting the operation of the database engine is not supported. Will be deprecated in the future. Look to Supported Features for 'OnlineResize'. ,
Enum:
{
Enabled: Resizing the storage without interrupting the operation of the database engine is supported. ,
Disabled: Resizing the storage without interrupting the operation of the database engine is not supported. ,
}
,
Required: False ,
}
enum ,
restricted:
{
Description: Indicates if this location is restricted. 'Enabled' means location is restricted. 'Disabled' stands for location is not restricted. Will be deprecated in the future. Look to Supported Features for 'Restricted'. ,
Enum:
{
Enabled: Location is restricted. ,
Disabled: Location is not restricted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page 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 ,
}
,
]
,
}
,
}
CapabilitiesByServer_List (updated)
Description :  Lists the capabilities available for a given server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CapabilitiesByServer_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "supportedServerEditions": {
                "$properties": {
                  "supportedServerSkus": {
                    "$properties": {
                      "supportedHaMode": {
                        "Enum": {
                          "new": [
                            [
                              "SameZone",
                              "High availability is enabled for the server, with standby server in the same availability zone as the primary."
                            ],
                            [
                              "ZoneRedundant",
                              "High availability is enabled for the server, with standby server in a different availability zone than that of the primary."
                            ]
                          ],
                          "old": [
                            [
                              "SameZone",
                              ""
                            ],
                            [
                              "ZoneRedundant",
                              ""
                            ]
                          ]
                        }
                      },
                      "supportedFeatures": {
                        "$properties": [
                          {
                            "#name": "status",
                            "Enum": {
                              "new": [
                                [
                                  "Enabled",
                                  "Feature is enabled."
                                ],
                                [
                                  "Disabled",
                                  "Feature is disabled."
                                ]
                              ],
                              "old": [
                                [
                                  "Enabled",
                                  ""
                                ],
                                [
                                  "Disabled",
                                  ""
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              }
            },
            {
              "supportedServerVersions": {
                "$properties": {
                  "supportedFeatures": {
                    "$properties": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Enabled",
                              "Feature is enabled."
                            ],
                            [
                              "Disabled",
                              "Feature is disabled."
                            ]
                          ],
                          "old": [
                            [
                              "Enabled",
                              ""
                            ],
                            [
                              "Disabled",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  }
                }
              }
            },
            {
              "supportedFeatures": {
                "$properties": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Feature is enabled."
                        ],
                        [
                          "Disabled",
                          "Feature is disabled."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "fastProvisioningSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Fast provisioning is supported."
                  ],
                  [
                    "Disabled",
                    "Fast provisioning is not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "geoBackupSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Geographically redundant backups are supported."
                  ],
                  [
                    "Disabled",
                    "Geographically redundant backups are not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "zoneRedundantHaSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "High availability with zone redundancy is supported."
                  ],
                  [
                    "Disabled",
                    "High availability with zone redundancy is not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "zoneRedundantHaAndGeoBackupSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "High availability with zone redundancy is supported in conjunction with geographically redundant backups."
                  ],
                  [
                    "Disabled",
                    "High availability with zone redundancy is not supported in conjunction with geographically redundant backups."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "storageAutoGrowthSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Storage autogrow is supported."
                  ],
                  [
                    "Disabled",
                    "Storage autogrow is not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "onlineResizeSupported",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Resizing the storage without interrupting the operation of the database engine is supported."
                  ],
                  [
                    "Disabled",
                    "Resizing the storage without interrupting the operation of the database engine is not supported."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "restricted",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Location is restricted."
                  ],
                  [
                    "Disabled",
                    "Location is not restricted."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ 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: List of supported capabilities. ,
Required: False ,
}
[
{
name:
{
Description: Name of flexible servers capabilities. ,
Required: False ,
}
string ,
supportedServerEditions:
{
Description: List of supported compute tiers. ,
Required: False ,
}
[
{
name:
{
Description: Name of compute tier. ,
Required: False ,
}
string ,
defaultSkuName:
{
Description: Default compute name (SKU) for this computer tier. ,
Required: False ,
}
string ,
supportedStorageEditions:
{
Description: List of storage editions supported by this compute tier and compute name. ,
Required: False ,
}
[
{
name:
{
Description: Name of storage tier. ,
Required: False ,
}
string ,
defaultStorageSizeMb:
{
Description: Default storage size (in MB) for this storage tier. ,
Format: int64 ,
Required: False ,
}
integer ,
supportedStorageMb:
{
Description: Configurations of storage supported for this storage tier. ,
Required: False ,
}
[
{
supportedIops:
{
Description: Minimum IOPS supported by the storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMaximumIops:
{
Description: Maximum IOPS supported by the storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeMb:
{
Description: Minimum supported size (in MB) of storage. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumStorageSizeMb:
{
Description: Maximum supported size (in MB) of storage. ,
Format: int64 ,
Required: False ,
}
integer ,
supportedThroughput:
{
Description: Minimum supported throughput (in MB/s) of storage. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMaximumThroughput:
{
Description: Maximum supported throughput (in MB/s) of storage. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultIopsTier:
{
Description: Default IOPS for this tier and storage size. ,
Required: False ,
}
string ,
supportedIopsTiers:
{
Description: List of all supported storage tiers for this tier and storage size. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage tier. ,
Required: False ,
}
string ,
iops:
{
Description: Supported IOPS for the storage tier. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
supportedServerSkus:
{
Description: List of supported compute names (SKUs). ,
Required: False ,
}
[
{
name:
{
Description: Name of the compute (SKU). ,
Required: False ,
}
string ,
vCores:
{
Description: vCores available for this compute. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedIops:
{
Description: Maximum IOPS supported by this compute. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMemoryPerVcoreMb:
{
Description: Supported memory (in MB) per virtual core assigned to this compute. ,
Format: int64 ,
Required: False ,
}
integer ,
supportedZones:
{
Description: List of supported availability zones. E.g. '1', '2', '3' ,
Required: False ,
}
[
string ,
]
,
supportedHaMode:
{
Description: Modes of high availability supported for this compute. ,
Required: False ,
}
[
string ,
]
,
supportedFeatures:
{
Description: Features supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the feature. ,
Required: False ,
}
string ,
status:
{
Description: Status of the feature. Indicates if the feature is enabled or not. ,
Enum:
{
Enabled: Feature is enabled. ,
Disabled: Feature is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
securityProfile:
{
Description: Security profile of the compute. Indicates if it's a Confidential Compute virtual machine. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
supportedServerVersions:
{
Description: List of supported major versions of PostgreSQL database engine. ,
Required: False ,
}
[
{
name:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
supportedVersionsToUpgrade:
{
Description: Major versions of PostgreSQL database engine to which this version can be automatically upgraded. ,
Required: False ,
}
[
string ,
]
,
supportedFeatures:
{
Description: Features supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the feature. ,
Required: False ,
}
string ,
status:
{
Description: Status of the feature. Indicates if the feature is enabled or not. ,
Enum:
{
Enabled: Feature is enabled. ,
Disabled: Feature is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
supportedFeatures:
{
Description: Features supported. ,
Required: False ,
}
[
{
name:
{
Description: Name of the feature. ,
Required: False ,
}
string ,
status:
{
Description: Status of the feature. Indicates if the feature is enabled or not. ,
Enum:
{
Enabled: Feature is enabled. ,
Disabled: Feature is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
fastProvisioningSupported:
{
Description: Indicates if fast provisioning is supported. 'Enabled' means fast provisioning is supported. 'Disabled' stands for fast provisioning is not supported. Will be deprecated in the future. Look to Supported Features for 'FastProvisioning'. ,
Enum:
{
Enabled: Fast provisioning is supported. ,
Disabled: Fast provisioning is not supported. ,
}
,
Required: False ,
}
enum ,
supportedFastProvisioningEditions:
{
Description: List of compute tiers supporting fast provisioning. ,
Required: False ,
}
[
{
supportedTier:
{
Description: Compute tier supporting fast provisioning. ,
Required: False ,
}
string ,
supportedSku:
{
Description: Compute name (SKU) supporting fast provisioning. ,
Required: False ,
}
string ,
supportedStorageGb:
{
Description: Storage size (in GB) supporting fast provisioning. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedServerVersions:
{
Description: Major version of PostgreSQL database engine supporting fast provisioning. ,
Required: False ,
}
string ,
serverCount:
{
Description: Count of servers in cache matching this specification. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
geoBackupSupported:
{
Description: Indicates if geographically redundant backups are supported in this location. 'Enabled' means geographically redundant backups are supported. 'Disabled' stands for geographically redundant backup is not supported. Will be deprecated in the future. Look to Supported Features for 'GeoBackup'. ,
Enum:
{
Enabled: Geographically redundant backups are supported. ,
Disabled: Geographically redundant backups are not supported. ,
}
,
Required: False ,
}
enum ,
zoneRedundantHaSupported:
{
Description: Indicates if high availability with zone redundancy is supported in this location. 'Enabled' means high availability with zone redundancy is supported. 'Disabled' stands for high availability with zone redundancy is not supported. Will be deprecated in the future. Look to Supported Features for 'ZoneRedundantHa'. ,
Enum:
{
Enabled: High availability with zone redundancy is supported. ,
Disabled: High availability with zone redundancy is not supported. ,
}
,
Required: False ,
}
enum ,
zoneRedundantHaAndGeoBackupSupported:
{
Description: Indicates if high availability with zone redundancy is supported in conjunction with geographically redundant backups in this location. 'Enabled' means high availability with zone redundancy is supported in conjunction with geographically redundant backups is supported. 'Disabled' stands for high availability with zone redundancy is supported in conjunction with geographically redundant backups is not supported. Will be deprecated in the future. Look to Supported Features for 'ZoneRedundantHaAndGeoBackup'. ,
Enum:
{
Enabled: High availability with zone redundancy is supported in conjunction with geographically redundant backups. ,
Disabled: High availability with zone redundancy is not supported in conjunction with geographically redundant backups. ,
}
,
Required: False ,
}
enum ,
storageAutoGrowthSupported:
{
Description: Indicates if storage autogrow is supported in this location. 'Enabled' means storage autogrow is supported. 'Disabled' stands for storage autogrow is not supported. Will be deprecated in the future. Look to Supported Features for 'StorageAutoGrowth'. ,
Enum:
{
Enabled: Storage autogrow is supported. ,
Disabled: Storage autogrow is not supported. ,
}
,
Required: False ,
}
enum ,
onlineResizeSupported:
{
Description: Indicates if resizing the storage, without interrupting the operation of the database engine, is supported in this location for the given subscription. 'Enabled' means resizing the storage without interrupting the operation of the database engine is supported. 'Disabled' means resizing the storage without interrupting the operation of the database engine is not supported. Will be deprecated in the future. Look to Supported Features for 'OnlineResize'. ,
Enum:
{
Enabled: Resizing the storage without interrupting the operation of the database engine is supported. ,
Disabled: Resizing the storage without interrupting the operation of the database engine is not supported. ,
}
,
Required: False ,
}
enum ,
restricted:
{
Description: Indicates if this location is restricted. 'Enabled' means location is restricted. 'Disabled' stands for location is not restricted. Will be deprecated in the future. Look to Supported Features for 'Restricted'. ,
Enum:
{
Enabled: Location is restricted. ,
Disabled: Location is not restricted. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page 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 ,
}
,
]
,
}
,
}
Configurations_ListByServer (updated)
Description :  Lists all configurations (also known as server parameters) of a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_ListByServer",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "dataType",
                "Enum": {
                  "new": [
                    [
                      "Boolean",
                      "A boolean value."
                    ],
                    [
                      "Numeric",
                      "A numeric value."
                    ],
                    [
                      "Integer",
                      "An integer value."
                    ],
                    [
                      "Enumeration",
                      "An enumeration value."
                    ],
                    [
                      "String",
                      "A string value."
                    ],
                    [
                      "Set",
                      "A set of values."
                    ]
                  ],
                  "old": [
                    [
                      "Boolean",
                      ""
                    ],
                    [
                      "Numeric",
                      ""
                    ],
                    [
                      "Integer",
                      ""
                    ],
                    [
                      "Enumeration",
                      ""
                    ],
                    [
                      "String",
                      ""
                    ],
                    [
                      "Set",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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: List of configurations (also known as server parameters). ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a configuration (also known as server parameter). ,
Required: False ,
}
{
value:
{
Description: Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
defaultValue:
{
Description: Value assigned by default to the configuration (also known as server parameter). ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration (also known as server parameter). ,
Enum:
{
Boolean: A boolean value. ,
Numeric: A numeric value. ,
Integer: An integer value. ,
Enumeration: An enumeration value. ,
String: A string value. ,
Set: A set of values. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
source:
{
Description: Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter). ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect. ,
Required: False ,
}
boolean ,
unit:
{
Description: Units in which the configuration (also known as server parameter) value is expressed. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Link pointing to the documentation of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link used to get the next page 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 ,
}
,
]
,
}
,
}
Configurations_Get (updated)
Description :  Gets information about a specific configuration (also known as server parameter) of a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "dataType",
            "Enum": {
              "new": [
                [
                  "Boolean",
                  "A boolean value."
                ],
                [
                  "Numeric",
                  "A numeric value."
                ],
                [
                  "Integer",
                  "An integer value."
                ],
                [
                  "Enumeration",
                  "An enumeration value."
                ],
                [
                  "String",
                  "A string value."
                ],
                [
                  "Set",
                  "A set of values."
                ]
              ],
              "old": [
                [
                  "Boolean",
                  ""
                ],
                [
                  "Numeric",
                  ""
                ],
                [
                  "Integer",
                  ""
                ],
                [
                  "Enumeration",
                  ""
                ],
                [
                  "String",
                  ""
                ],
                [
                  "Set",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Name of the configuration (also known as server parameter). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a configuration (also known as server parameter). ,
Required: False ,
}
{
value:
{
Description: Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
defaultValue:
{
Description: Value assigned by default to the configuration (also known as server parameter). ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration (also known as server parameter). ,
Enum:
{
Boolean: A boolean value. ,
Numeric: A numeric value. ,
Integer: An integer value. ,
Enumeration: An enumeration value. ,
String: A string value. ,
Set: A set of values. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
source:
{
Description: Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter). ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect. ,
Required: False ,
}
boolean ,
unit:
{
Description: Units in which the configuration (also known as server parameter) value is expressed. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Link pointing to the documentation of the configuration (also known as server parameter). ,
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 (updated)
Description :  Updates the value assigned to a specific modifiable configuration (also known as server parameter) of a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "dataType",
            "Enum": {
              "new": [
                [
                  "Boolean",
                  "A boolean value."
                ],
                [
                  "Numeric",
                  "A numeric value."
                ],
                [
                  "Integer",
                  "An integer value."
                ],
                [
                  "Enumeration",
                  "An enumeration value."
                ],
                [
                  "String",
                  "A string value."
                ],
                [
                  "Set",
                  "A set of values."
                ]
              ],
              "old": [
                [
                  "Boolean",
                  ""
                ],
                [
                  "Numeric",
                  ""
                ],
                [
                  "Integer",
                  ""
                ],
                [
                  "Enumeration",
                  ""
                ],
                [
                  "String",
                  ""
                ],
                [
                  "Set",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Name of the configuration (also known as server parameter). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to update the value of a specific modifiable configuration (also known as server parameter). ,
Required: True ,
}
{
properties:
{
Description: Properties of a configuration (also known as server parameter). ,
Required: False ,
}
{
value:
{
Description: Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
defaultValue:
{
Description: Value assigned by default to the configuration (also known as server parameter). ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration (also known as server parameter). ,
Enum:
{
Boolean: A boolean value. ,
Numeric: A numeric value. ,
Integer: An integer value. ,
Enumeration: An enumeration value. ,
String: A string value. ,
Set: A set of values. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
source:
{
Description: Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter). ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect. ,
Required: False ,
}
boolean ,
unit:
{
Description: Units in which the configuration (also known as server parameter) value is expressed. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Link pointing to the documentation of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: 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 (updated)
Description :  Updates, using Put verb, the value assigned to a specific modifiable configuration (also known as server parameter) of a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_Put",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "dataType",
            "Enum": {
              "new": [
                [
                  "Boolean",
                  "A boolean value."
                ],
                [
                  "Numeric",
                  "A numeric value."
                ],
                [
                  "Integer",
                  "An integer value."
                ],
                [
                  "Enumeration",
                  "An enumeration value."
                ],
                [
                  "String",
                  "A string value."
                ],
                [
                  "Set",
                  "A set of values."
                ]
              ],
              "old": [
                [
                  "Boolean",
                  ""
                ],
                [
                  "Numeric",
                  ""
                ],
                [
                  "Integer",
                  ""
                ],
                [
                  "Enumeration",
                  ""
                ],
                [
                  "String",
                  ""
                ],
                [
                  "Set",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Name of the configuration (also known as server parameter). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to update the value of a specific modifiable configuration (also known as server parameter). ,
Required: True ,
}
{
properties:
{
Description: Properties of a configuration (also known as server parameter). ,
Required: False ,
}
{
value:
{
Description: Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
defaultValue:
{
Description: Value assigned by default to the configuration (also known as server parameter). ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration (also known as server parameter). ,
Enum:
{
Boolean: A boolean value. ,
Numeric: A numeric value. ,
Integer: An integer value. ,
Enumeration: An enumeration value. ,
String: A string value. ,
Set: A set of values. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
source:
{
Description: Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter). ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect. ,
Required: False ,
}
boolean ,
unit:
{
Description: Units in which the configuration (also known as server parameter) value is expressed. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Link pointing to the documentation of the configuration (also known as server parameter). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: 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 (updated)
Description :  Creates a new migration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migrations_Create",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "currentStatus": [
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "InProgress",
                      "Migration is in progress."
                    ],
                    [
                      "WaitingForUserAction",
                      "Migration is waiting for user action."
                    ],
                    [
                      "Canceled",
                      "Migration has been canceled."
                    ],
                    [
                      "Failed",
                      "Migration has failed."
                    ],
                    [
                      "Succeeded",
                      "Migration has succeeded."
                    ],
                    [
                      "ValidationFailed",
                      "Validation for migration has failed."
                    ],
                    [
                      "CleaningUp",
                      "Migration is cleaning up resources."
                    ]
                  ],
                  "old": [
                    [
                      "InProgress",
                      ""
                    ],
                    [
                      "WaitingForUserAction",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "ValidationFailed",
                      ""
                    ],
                    [
                      "CleaningUp",
                      ""
                    ]
                  ]
                }
              },
              {
                "currentSubStateDetails": [
                  {
                    "#name": "currentSubState",
                    "Enum": {
                      "new": [
                        [
                          "PerformingPreRequisiteSteps",
                          "Performing pre-requisite steps for migration."
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          "Waiting for logical replication setup request on source database."
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          "Waiting for databases to migrate specification."
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          "Waiting for target database overwrite confirmation."
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          "Waiting for data migration scheduling."
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          "Waiting for data migration window."
                        ],
                        [
                          "MigratingData",
                          "Migrating data."
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          "Waiting for cutover trigger."
                        ],
                        [
                          "CompletingMigration",
                          "Completing migration."
                        ],
                        [
                          "Completed",
                          "Migration completed."
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          "Canceling requested database migrations."
                        ],
                        [
                          "ValidationInProgress",
                          "Validation in progress."
                        ]
                      ],
                      "old": [
                        [
                          "PerformingPreRequisiteSteps",
                          ""
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          ""
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          ""
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          ""
                        ],
                        [
                          "MigratingData",
                          ""
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          ""
                        ],
                        [
                          "CompletingMigration",
                          ""
                        ],
                        [
                          "Completed",
                          ""
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          ""
                        ],
                        [
                          "ValidationInProgress",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "validationDetails": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Failed",
                              "Validation has failed."
                            ],
                            [
                              "Succeeded",
                              "Validation has succeeded."
                            ],
                            [
                              "Warning",
                              "Validation has succeeded with warnings."
                            ]
                          ],
                          "old": [
                            [
                              "Failed",
                              ""
                            ],
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Warning",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "serverLevelValidationDetails": {
                          "$properties": [
                            {
                              "#name": "state",
                              "Enum": {
                                "new": [
                                  [
                                    "Failed",
                                    "Validation has failed."
                                  ],
                                  [
                                    "Succeeded",
                                    "Validation has succeeded."
                                  ],
                                  [
                                    "Warning",
                                    "Validation has succeeded with warnings."
                                  ]
                                ],
                                "old": [
                                  [
                                    "Failed",
                                    ""
                                  ],
                                  [
                                    "Succeeded",
                                    ""
                                  ],
                                  [
                                    "Warning",
                                    ""
                                  ]
                                ]
                              }
                            },
                            {
                              "messages": {
                                "$properties": [
                                  {
                                    "#name": "state",
                                    "Enum": {
                                      "new": [
                                        [
                                          "Failed",
                                          "Validation has failed."
                                        ],
                                        [
                                          "Succeeded",
                                          "Validation has succeeded."
                                        ],
                                        [
                                          "Warning",
                                          "Validation has succeeded with warnings."
                                        ]
                                      ],
                                      "old": [
                                        [
                                          "Failed",
                                          ""
                                        ],
                                        [
                                          "Succeeded",
                                          ""
                                        ],
                                        [
                                          "Warning",
                                          ""
                                        ]
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "dbLevelValidationDetails": {
                          "$properties": {
                            "summary": {
                              "$properties": [
                                {
                                  "#name": "state",
                                  "Enum": {
                                    "new": [
                                      [
                                        "Failed",
                                        "Validation has failed."
                                      ],
                                      [
                                        "Succeeded",
                                        "Validation has succeeded."
                                      ],
                                      [
                                        "Warning",
                                        "Validation has succeeded with warnings."
                                      ]
                                    ],
                                    "old": [
                                      [
                                        "Failed",
                                        ""
                                      ],
                                      [
                                        "Succeeded",
                                        ""
                                      ],
                                      [
                                        "Warning",
                                        ""
                                      ]
                                    ]
                                  }
                                },
                                {
                                  "messages": {
                                    "$properties": [
                                      {
                                        "#name": "state",
                                        "Enum": {
                                          "new": [
                                            [
                                              "Failed",
                                              "Validation has failed."
                                            ],
                                            [
                                              "Succeeded",
                                              "Validation has succeeded."
                                            ],
                                            [
                                              "Warning",
                                              "Validation has succeeded with warnings."
                                            ]
                                          ],
                                          "old": [
                                            [
                                              "Failed",
                                              ""
                                            ],
                                            [
                                              "Succeeded",
                                              ""
                                            ],
                                            [
                                              "Warning",
                                              ""
                                            ]
                                          ]
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "migrationMode",
            "Enum": {
              "new": [
                [
                  "Offline",
                  "Offline migration mode."
                ],
                [
                  "Online",
                  "Online migration mode."
                ]
              ],
              "old": [
                [
                  "Offline",
                  ""
                ],
                [
                  "Online",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrationOption",
            "Enum": {
              "new": [
                [
                  "Validate",
                  "Validate the migration without performing it."
                ],
                [
                  "Migrate",
                  "Perform the migration."
                ],
                [
                  "ValidateAndMigrate",
                  "Validate and perform the migration."
                ]
              ],
              "old": [
                [
                  "Validate",
                  ""
                ],
                [
                  "Migrate",
                  ""
                ],
                [
                  "ValidateAndMigrate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sourceType",
            "Enum": {
              "new": [
                [
                  "OnPremises",
                  "On-premises PostgreSQL server."
                ],
                [
                  "AWS",
                  "Amazon Web Services PostgreSQL server."
                ],
                [
                  "GCP",
                  "Google Cloud Platform PostgreSQL server."
                ],
                [
                  "AzureVM",
                  "Azure Virtual Machine PostgreSQL server."
                ],
                [
                  "PostgreSQLSingleServer",
                  "Azure Database for PostgreSQL single server."
                ],
                [
                  "AWS_RDS",
                  "Amazon RDS for PostgreSQL."
                ],
                [
                  "AWS_AURORA",
                  "Amazon Aurora for PostgreSQL."
                ],
                [
                  "AWS_EC2",
                  "Amazon EC2 for PostgreSQL."
                ],
                [
                  "GCP_CloudSQL",
                  "Google Cloud SQL for PostgreSQL."
                ],
                [
                  "GCP_AlloyDB",
                  "Google Cloud AlloyDB for PostgreSQL."
                ],
                [
                  "GCP_Compute",
                  "Google Compute Engine for PostgreSQL."
                ],
                [
                  "EDB",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "EDB_Oracle_Server",
                  "EnterpriseDB Oracle Server."
                ],
                [
                  "EDB_PostgreSQL",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "PostgreSQLFlexibleServer",
                  "Azure Database for PostgreSQL flexible server."
                ],
                [
                  "PostgreSQLCosmosDB",
                  ".NET Cosmos DB for PostgreSQL"
                ],
                [
                  "Huawei_RDS",
                  "Huawei RDS for PostgreSQL"
                ],
                [
                  "Huawei_Compute",
                  "Huawei Compute for PostgreSQL"
                ],
                [
                  "Heroku_PostgreSQL",
                  "Heroku PostgreSQL"
                ],
                [
                  "Crunchy_PostgreSQL",
                  "Crunchy PostgreSQL"
                ],
                [
                  "ApsaraDB_RDS",
                  "ApsaraDB RDS for PostgreSQL"
                ],
                [
                  "Digital_Ocean_Droplets",
                  "Digital Ocean Droplets for PostgreSQL"
                ],
                [
                  "Digital_Ocean_PostgreSQL",
                  "Digital Ocean PostgreSQL"
                ],
                [
                  "Supabase_PostgreSQL",
                  "Supabase PostgreSQL"
                ]
              ],
              "old": [
                [
                  "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",
                  ""
                ],
                [
                  "Supabase_PostgreSQL",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sslMode",
            "Enum": {
              "new": [
                [
                  "Prefer",
                  "Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL."
                ],
                [
                  "Require",
                  "Require SSL connection. If the server does not support SSL, the connection will fail."
                ],
                [
                  "VerifyCA",
                  "Require SSL connection and verify the server certificate against the CA certificate."
                ],
                [
                  "VerifyFull",
                  "Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate."
                ]
              ],
              "old": [
                [
                  "Prefer",
                  ""
                ],
                [
                  "Require",
                  ""
                ],
                [
                  "VerifyCA",
                  ""
                ],
                [
                  "VerifyFull",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
            "Enum": {
              "new": [
                [
                  "True",
                  "Logical replication will be set up on the source server."
                ],
                [
                  "False",
                  "Logical replication will not be set up on the source server."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "overwriteDbsInTarget",
            "Enum": {
              "new": [
                [
                  "True",
                  "Databases on the target server can be overwritten when already present."
                ],
                [
                  "False",
                  "Databases on the target server cannot be overwritten when already present."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrateRoles",
            "Enum": {
              "new": [
                [
                  "True",
                  "Roles and permissions will be migrated."
                ],
                [
                  "False",
                  "Roles and permissions will not be migrated."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "startDataMigration",
            "Enum": {
              "new": [
                [
                  "True",
                  "Data migration must start right away."
                ],
                [
                  "False",
                  "Data migration must not start right away."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "triggerCutover",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cutover must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cutover must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "cancel",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cancel must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cancel must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "currentStatus": [
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "InProgress",
                      "Migration is in progress."
                    ],
                    [
                      "WaitingForUserAction",
                      "Migration is waiting for user action."
                    ],
                    [
                      "Canceled",
                      "Migration has been canceled."
                    ],
                    [
                      "Failed",
                      "Migration has failed."
                    ],
                    [
                      "Succeeded",
                      "Migration has succeeded."
                    ],
                    [
                      "ValidationFailed",
                      "Validation for migration has failed."
                    ],
                    [
                      "CleaningUp",
                      "Migration is cleaning up resources."
                    ]
                  ],
                  "old": [
                    [
                      "InProgress",
                      ""
                    ],
                    [
                      "WaitingForUserAction",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "ValidationFailed",
                      ""
                    ],
                    [
                      "CleaningUp",
                      ""
                    ]
                  ]
                }
              },
              {
                "currentSubStateDetails": [
                  {
                    "#name": "currentSubState",
                    "Enum": {
                      "new": [
                        [
                          "PerformingPreRequisiteSteps",
                          "Performing pre-requisite steps for migration."
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          "Waiting for logical replication setup request on source database."
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          "Waiting for databases to migrate specification."
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          "Waiting for target database overwrite confirmation."
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          "Waiting for data migration scheduling."
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          "Waiting for data migration window."
                        ],
                        [
                          "MigratingData",
                          "Migrating data."
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          "Waiting for cutover trigger."
                        ],
                        [
                          "CompletingMigration",
                          "Completing migration."
                        ],
                        [
                          "Completed",
                          "Migration completed."
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          "Canceling requested database migrations."
                        ],
                        [
                          "ValidationInProgress",
                          "Validation in progress."
                        ]
                      ],
                      "old": [
                        [
                          "PerformingPreRequisiteSteps",
                          ""
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          ""
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          ""
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          ""
                        ],
                        [
                          "MigratingData",
                          ""
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          ""
                        ],
                        [
                          "CompletingMigration",
                          ""
                        ],
                        [
                          "Completed",
                          ""
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          ""
                        ],
                        [
                          "ValidationInProgress",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "validationDetails": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Failed",
                              "Validation has failed."
                            ],
                            [
                              "Succeeded",
                              "Validation has succeeded."
                            ],
                            [
                              "Warning",
                              "Validation has succeeded with warnings."
                            ]
                          ],
                          "old": [
                            [
                              "Failed",
                              ""
                            ],
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Warning",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "serverLevelValidationDetails": {
                          "$properties": [
                            {
                              "#name": "state",
                              "Enum": {
                                "new": [
                                  [
                                    "Failed",
                                    "Validation has failed."
                                  ],
                                  [
                                    "Succeeded",
                                    "Validation has succeeded."
                                  ],
                                  [
                                    "Warning",
                                    "Validation has succeeded with warnings."
                                  ]
                                ],
                                "old": [
                                  [
                                    "Failed",
                                    ""
                                  ],
                                  [
                                    "Succeeded",
                                    ""
                                  ],
                                  [
                                    "Warning",
                                    ""
                                  ]
                                ]
                              }
                            },
                            {
                              "messages": {
                                "$properties": [
                                  {
                                    "#name": "state",
                                    "Enum": {
                                      "new": [
                                        [
                                          "Failed",
                                          "Validation has failed."
                                        ],
                                        [
                                          "Succeeded",
                                          "Validation has succeeded."
                                        ],
                                        [
                                          "Warning",
                                          "Validation has succeeded with warnings."
                                        ]
                                      ],
                                      "old": [
                                        [
                                          "Failed",
                                          ""
                                        ],
                                        [
                                          "Succeeded",
                                          ""
                                        ],
                                        [
                                          "Warning",
                                          ""
                                        ]
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "dbLevelValidationDetails": {
                          "$properties": {
                            "summary": {
                              "$properties": [
                                {
                                  "#name": "state",
                                  "Enum": {
                                    "new": [
                                      [
                                        "Failed",
                                        "Validation has failed."
                                      ],
                                      [
                                        "Succeeded",
                                        "Validation has succeeded."
                                      ],
                                      [
                                        "Warning",
                                        "Validation has succeeded with warnings."
                                      ]
                                    ],
                                    "old": [
                                      [
                                        "Failed",
                                        ""
                                      ],
                                      [
                                        "Succeeded",
                                        ""
                                      ],
                                      [
                                        "Warning",
                                        ""
                                      ]
                                    ]
                                  }
                                },
                                {
                                  "messages": {
                                    "$properties": [
                                      {
                                        "#name": "state",
                                        "Enum": {
                                          "new": [
                                            [
                                              "Failed",
                                              "Validation has failed."
                                            ],
                                            [
                                              "Succeeded",
                                              "Validation has succeeded."
                                            ],
                                            [
                                              "Warning",
                                              "Validation has succeeded with warnings."
                                            ]
                                          ],
                                          "old": [
                                            [
                                              "Failed",
                                              ""
                                            ],
                                            [
                                              "Succeeded",
                                              ""
                                            ],
                                            [
                                              "Warning",
                                              ""
                                            ]
                                          ]
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "migrationMode",
            "Enum": {
              "new": [
                [
                  "Offline",
                  "Offline migration mode."
                ],
                [
                  "Online",
                  "Online migration mode."
                ]
              ],
              "old": [
                [
                  "Offline",
                  ""
                ],
                [
                  "Online",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrationOption",
            "Enum": {
              "new": [
                [
                  "Validate",
                  "Validate the migration without performing it."
                ],
                [
                  "Migrate",
                  "Perform the migration."
                ],
                [
                  "ValidateAndMigrate",
                  "Validate and perform the migration."
                ]
              ],
              "old": [
                [
                  "Validate",
                  ""
                ],
                [
                  "Migrate",
                  ""
                ],
                [
                  "ValidateAndMigrate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sourceType",
            "Enum": {
              "new": [
                [
                  "OnPremises",
                  "On-premises PostgreSQL server."
                ],
                [
                  "AWS",
                  "Amazon Web Services PostgreSQL server."
                ],
                [
                  "GCP",
                  "Google Cloud Platform PostgreSQL server."
                ],
                [
                  "AzureVM",
                  "Azure Virtual Machine PostgreSQL server."
                ],
                [
                  "PostgreSQLSingleServer",
                  "Azure Database for PostgreSQL single server."
                ],
                [
                  "AWS_RDS",
                  "Amazon RDS for PostgreSQL."
                ],
                [
                  "AWS_AURORA",
                  "Amazon Aurora for PostgreSQL."
                ],
                [
                  "AWS_EC2",
                  "Amazon EC2 for PostgreSQL."
                ],
                [
                  "GCP_CloudSQL",
                  "Google Cloud SQL for PostgreSQL."
                ],
                [
                  "GCP_AlloyDB",
                  "Google Cloud AlloyDB for PostgreSQL."
                ],
                [
                  "GCP_Compute",
                  "Google Compute Engine for PostgreSQL."
                ],
                [
                  "EDB",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "EDB_Oracle_Server",
                  "EnterpriseDB Oracle Server."
                ],
                [
                  "EDB_PostgreSQL",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "PostgreSQLFlexibleServer",
                  "Azure Database for PostgreSQL flexible server."
                ],
                [
                  "PostgreSQLCosmosDB",
                  ".NET Cosmos DB for PostgreSQL"
                ],
                [
                  "Huawei_RDS",
                  "Huawei RDS for PostgreSQL"
                ],
                [
                  "Huawei_Compute",
                  "Huawei Compute for PostgreSQL"
                ],
                [
                  "Heroku_PostgreSQL",
                  "Heroku PostgreSQL"
                ],
                [
                  "Crunchy_PostgreSQL",
                  "Crunchy PostgreSQL"
                ],
                [
                  "ApsaraDB_RDS",
                  "ApsaraDB RDS for PostgreSQL"
                ],
                [
                  "Digital_Ocean_Droplets",
                  "Digital Ocean Droplets for PostgreSQL"
                ],
                [
                  "Digital_Ocean_PostgreSQL",
                  "Digital Ocean PostgreSQL"
                ],
                [
                  "Supabase_PostgreSQL",
                  "Supabase PostgreSQL"
                ]
              ],
              "old": [
                [
                  "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",
                  ""
                ],
                [
                  "Supabase_PostgreSQL",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sslMode",
            "Enum": {
              "new": [
                [
                  "Prefer",
                  "Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL."
                ],
                [
                  "Require",
                  "Require SSL connection. If the server does not support SSL, the connection will fail."
                ],
                [
                  "VerifyCA",
                  "Require SSL connection and verify the server certificate against the CA certificate."
                ],
                [
                  "VerifyFull",
                  "Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate."
                ]
              ],
              "old": [
                [
                  "Prefer",
                  ""
                ],
                [
                  "Require",
                  ""
                ],
                [
                  "VerifyCA",
                  ""
                ],
                [
                  "VerifyFull",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
            "Enum": {
              "new": [
                [
                  "True",
                  "Logical replication will be set up on the source server."
                ],
                [
                  "False",
                  "Logical replication will not be set up on the source server."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "overwriteDbsInTarget",
            "Enum": {
              "new": [
                [
                  "True",
                  "Databases on the target server can be overwritten when already present."
                ],
                [
                  "False",
                  "Databases on the target server cannot be overwritten when already present."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrateRoles",
            "Enum": {
              "new": [
                [
                  "True",
                  "Roles and permissions will be migrated."
                ],
                [
                  "False",
                  "Roles and permissions will not be migrated."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "startDataMigration",
            "Enum": {
              "new": [
                [
                  "True",
                  "Data migration must start right away."
                ],
                [
                  "False",
                  "Data migration must not start right away."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "triggerCutover",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cutover must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cutover must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "cancel",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cancel must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cancel must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "currentStatus": [
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "InProgress",
                      "Migration is in progress."
                    ],
                    [
                      "WaitingForUserAction",
                      "Migration is waiting for user action."
                    ],
                    [
                      "Canceled",
                      "Migration has been canceled."
                    ],
                    [
                      "Failed",
                      "Migration has failed."
                    ],
                    [
                      "Succeeded",
                      "Migration has succeeded."
                    ],
                    [
                      "ValidationFailed",
                      "Validation for migration has failed."
                    ],
                    [
                      "CleaningUp",
                      "Migration is cleaning up resources."
                    ]
                  ],
                  "old": [
                    [
                      "InProgress",
                      ""
                    ],
                    [
                      "WaitingForUserAction",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "ValidationFailed",
                      ""
                    ],
                    [
                      "CleaningUp",
                      ""
                    ]
                  ]
                }
              },
              {
                "currentSubStateDetails": [
                  {
                    "#name": "currentSubState",
                    "Enum": {
                      "new": [
                        [
                          "PerformingPreRequisiteSteps",
                          "Performing pre-requisite steps for migration."
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          "Waiting for logical replication setup request on source database."
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          "Waiting for databases to migrate specification."
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          "Waiting for target database overwrite confirmation."
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          "Waiting for data migration scheduling."
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          "Waiting for data migration window."
                        ],
                        [
                          "MigratingData",
                          "Migrating data."
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          "Waiting for cutover trigger."
                        ],
                        [
                          "CompletingMigration",
                          "Completing migration."
                        ],
                        [
                          "Completed",
                          "Migration completed."
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          "Canceling requested database migrations."
                        ],
                        [
                          "ValidationInProgress",
                          "Validation in progress."
                        ]
                      ],
                      "old": [
                        [
                          "PerformingPreRequisiteSteps",
                          ""
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          ""
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          ""
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          ""
                        ],
                        [
                          "MigratingData",
                          ""
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          ""
                        ],
                        [
                          "CompletingMigration",
                          ""
                        ],
                        [
                          "Completed",
                          ""
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          ""
                        ],
                        [
                          "ValidationInProgress",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "validationDetails": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Failed",
                              "Validation has failed."
                            ],
                            [
                              "Succeeded",
                              "Validation has succeeded."
                            ],
                            [
                              "Warning",
                              "Validation has succeeded with warnings."
                            ]
                          ],
                          "old": [
                            [
                              "Failed",
                              ""
                            ],
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Warning",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "serverLevelValidationDetails": {
                          "$properties": [
                            {
                              "#name": "state",
                              "Enum": {
                                "new": [
                                  [
                                    "Failed",
                                    "Validation has failed."
                                  ],
                                  [
                                    "Succeeded",
                                    "Validation has succeeded."
                                  ],
                                  [
                                    "Warning",
                                    "Validation has succeeded with warnings."
                                  ]
                                ],
                                "old": [
                                  [
                                    "Failed",
                                    ""
                                  ],
                                  [
                                    "Succeeded",
                                    ""
                                  ],
                                  [
                                    "Warning",
                                    ""
                                  ]
                                ]
                              }
                            },
                            {
                              "messages": {
                                "$properties": [
                                  {
                                    "#name": "state",
                                    "Enum": {
                                      "new": [
                                        [
                                          "Failed",
                                          "Validation has failed."
                                        ],
                                        [
                                          "Succeeded",
                                          "Validation has succeeded."
                                        ],
                                        [
                                          "Warning",
                                          "Validation has succeeded with warnings."
                                        ]
                                      ],
                                      "old": [
                                        [
                                          "Failed",
                                          ""
                                        ],
                                        [
                                          "Succeeded",
                                          ""
                                        ],
                                        [
                                          "Warning",
                                          ""
                                        ]
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "dbLevelValidationDetails": {
                          "$properties": {
                            "summary": {
                              "$properties": [
                                {
                                  "#name": "state",
                                  "Enum": {
                                    "new": [
                                      [
                                        "Failed",
                                        "Validation has failed."
                                      ],
                                      [
                                        "Succeeded",
                                        "Validation has succeeded."
                                      ],
                                      [
                                        "Warning",
                                        "Validation has succeeded with warnings."
                                      ]
                                    ],
                                    "old": [
                                      [
                                        "Failed",
                                        ""
                                      ],
                                      [
                                        "Succeeded",
                                        ""
                                      ],
                                      [
                                        "Warning",
                                        ""
                                      ]
                                    ]
                                  }
                                },
                                {
                                  "messages": {
                                    "$properties": [
                                      {
                                        "#name": "state",
                                        "Enum": {
                                          "new": [
                                            [
                                              "Failed",
                                              "Validation has failed."
                                            ],
                                            [
                                              "Succeeded",
                                              "Validation has succeeded."
                                            ],
                                            [
                                              "Warning",
                                              "Validation has succeeded with warnings."
                                            ]
                                          ],
                                          "old": [
                                            [
                                              "Failed",
                                              ""
                                            ],
                                            [
                                              "Succeeded",
                                              ""
                                            ],
                                            [
                                              "Warning",
                                              ""
                                            ]
                                          ]
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "migrationMode",
            "Enum": {
              "new": [
                [
                  "Offline",
                  "Offline migration mode."
                ],
                [
                  "Online",
                  "Online migration mode."
                ]
              ],
              "old": [
                [
                  "Offline",
                  ""
                ],
                [
                  "Online",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrationOption",
            "Enum": {
              "new": [
                [
                  "Validate",
                  "Validate the migration without performing it."
                ],
                [
                  "Migrate",
                  "Perform the migration."
                ],
                [
                  "ValidateAndMigrate",
                  "Validate and perform the migration."
                ]
              ],
              "old": [
                [
                  "Validate",
                  ""
                ],
                [
                  "Migrate",
                  ""
                ],
                [
                  "ValidateAndMigrate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sourceType",
            "Enum": {
              "new": [
                [
                  "OnPremises",
                  "On-premises PostgreSQL server."
                ],
                [
                  "AWS",
                  "Amazon Web Services PostgreSQL server."
                ],
                [
                  "GCP",
                  "Google Cloud Platform PostgreSQL server."
                ],
                [
                  "AzureVM",
                  "Azure Virtual Machine PostgreSQL server."
                ],
                [
                  "PostgreSQLSingleServer",
                  "Azure Database for PostgreSQL single server."
                ],
                [
                  "AWS_RDS",
                  "Amazon RDS for PostgreSQL."
                ],
                [
                  "AWS_AURORA",
                  "Amazon Aurora for PostgreSQL."
                ],
                [
                  "AWS_EC2",
                  "Amazon EC2 for PostgreSQL."
                ],
                [
                  "GCP_CloudSQL",
                  "Google Cloud SQL for PostgreSQL."
                ],
                [
                  "GCP_AlloyDB",
                  "Google Cloud AlloyDB for PostgreSQL."
                ],
                [
                  "GCP_Compute",
                  "Google Compute Engine for PostgreSQL."
                ],
                [
                  "EDB",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "EDB_Oracle_Server",
                  "EnterpriseDB Oracle Server."
                ],
                [
                  "EDB_PostgreSQL",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "PostgreSQLFlexibleServer",
                  "Azure Database for PostgreSQL flexible server."
                ],
                [
                  "PostgreSQLCosmosDB",
                  ".NET Cosmos DB for PostgreSQL"
                ],
                [
                  "Huawei_RDS",
                  "Huawei RDS for PostgreSQL"
                ],
                [
                  "Huawei_Compute",
                  "Huawei Compute for PostgreSQL"
                ],
                [
                  "Heroku_PostgreSQL",
                  "Heroku PostgreSQL"
                ],
                [
                  "Crunchy_PostgreSQL",
                  "Crunchy PostgreSQL"
                ],
                [
                  "ApsaraDB_RDS",
                  "ApsaraDB RDS for PostgreSQL"
                ],
                [
                  "Digital_Ocean_Droplets",
                  "Digital Ocean Droplets for PostgreSQL"
                ],
                [
                  "Digital_Ocean_PostgreSQL",
                  "Digital Ocean PostgreSQL"
                ],
                [
                  "Supabase_PostgreSQL",
                  "Supabase PostgreSQL"
                ]
              ],
              "old": [
                [
                  "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",
                  ""
                ],
                [
                  "Supabase_PostgreSQL",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sslMode",
            "Enum": {
              "new": [
                [
                  "Prefer",
                  "Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL."
                ],
                [
                  "Require",
                  "Require SSL connection. If the server does not support SSL, the connection will fail."
                ],
                [
                  "VerifyCA",
                  "Require SSL connection and verify the server certificate against the CA certificate."
                ],
                [
                  "VerifyFull",
                  "Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate."
                ]
              ],
              "old": [
                [
                  "Prefer",
                  ""
                ],
                [
                  "Require",
                  ""
                ],
                [
                  "VerifyCA",
                  ""
                ],
                [
                  "VerifyFull",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
            "Enum": {
              "new": [
                [
                  "True",
                  "Logical replication will be set up on the source server."
                ],
                [
                  "False",
                  "Logical replication will not be set up on the source server."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "overwriteDbsInTarget",
            "Enum": {
              "new": [
                [
                  "True",
                  "Databases on the target server can be overwritten when already present."
                ],
                [
                  "False",
                  "Databases on the target server cannot be overwritten when already present."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrateRoles",
            "Enum": {
              "new": [
                [
                  "True",
                  "Roles and permissions will be migrated."
                ],
                [
                  "False",
                  "Roles and permissions will not be migrated."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "startDataMigration",
            "Enum": {
              "new": [
                [
                  "True",
                  "Data migration must start right away."
                ],
                [
                  "False",
                  "Data migration must not start right away."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "triggerCutover",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cutover must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cutover must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "cancel",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cancel must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cancel must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrations/{migrationName}
{
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 ,
migrationName:
{
Description: Name of migration. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required for creating a migration. ,
Required: True ,
}
{
properties:
{
Description: Migration properties. ,
Required: False ,
}
{
migrationId:
{
Description: Identifier of a migration. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of a migration. ,
Required: False ,
}
{
state:
{
Description: State of migration. ,
Enum:
{
InProgress: Migration is in progress. ,
WaitingForUserAction: Migration is waiting for user action. ,
Canceled: Migration has been canceled. ,
Failed: Migration has failed. ,
Succeeded: Migration has succeeded. ,
ValidationFailed: Validation for migration has failed. ,
CleaningUp: Migration is cleaning up resources. ,
}
,
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: Substate of migration. ,
Enum:
{
PerformingPreRequisiteSteps: Performing pre-requisite steps for migration. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: Waiting for logical replication setup request on source database. ,
WaitingForDBsToMigrateSpecification: Waiting for databases to migrate specification. ,
WaitingForTargetDBOverwriteConfirmation: Waiting for target database overwrite confirmation. ,
WaitingForDataMigrationScheduling: Waiting for data migration scheduling. ,
WaitingForDataMigrationWindow: Waiting for data migration window. ,
MigratingData: Migrating data. ,
WaitingForCutoverTrigger: Waiting for cutover trigger. ,
CompletingMigration: Completing migration. ,
Completed: Migration completed. ,
CancelingRequestedDBMigrations: Canceling requested database migrations. ,
ValidationInProgress: Validation in progress. ,
}
,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Start time (UTC) for validation. ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: End time (UTC) for validation. ,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations. ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of database. ,
Required: False ,
}
string ,
startedOn:
{
Description: Start time of a database level validation. ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End 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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: Identifier of the private endpoint migration instance. ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: Mode used to perform the migration: Online or Offline. ,
Enum:
{
Offline: Offline migration mode. ,
Online: Online migration mode. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: Supported option for a migration. ,
Enum:
{
Validate: Validate the migration without performing it. ,
Migrate: Perform the migration. ,
ValidateAndMigrate: Validate and perform the migration. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: On-premises PostgreSQL server. ,
AWS: Amazon Web Services PostgreSQL server. ,
GCP: Google Cloud Platform PostgreSQL server. ,
AzureVM: Azure Virtual Machine PostgreSQL server. ,
PostgreSQLSingleServer: Azure Database for PostgreSQL single server. ,
AWS_RDS: Amazon RDS for PostgreSQL. ,
AWS_AURORA: Amazon Aurora for PostgreSQL. ,
AWS_EC2: Amazon EC2 for PostgreSQL. ,
GCP_CloudSQL: Google Cloud SQL for PostgreSQL. ,
GCP_AlloyDB: Google Cloud AlloyDB for PostgreSQL. ,
GCP_Compute: Google Compute Engine for PostgreSQL. ,
EDB: EnterpriseDB PostgreSQL server. ,
EDB_Oracle_Server: EnterpriseDB Oracle Server. ,
EDB_PostgreSQL: EnterpriseDB PostgreSQL server. ,
PostgreSQLFlexibleServer: Azure Database for PostgreSQL flexible server. ,
PostgreSQLCosmosDB: .NET Cosmos DB for PostgreSQL ,
Huawei_RDS: Huawei RDS for PostgreSQL ,
Huawei_Compute: Huawei Compute for PostgreSQL ,
Heroku_PostgreSQL: Heroku PostgreSQL ,
Crunchy_PostgreSQL: Crunchy PostgreSQL ,
ApsaraDB_RDS: ApsaraDB RDS for PostgreSQL ,
Digital_Ocean_Droplets: Digital Ocean Droplets for PostgreSQL ,
Digital_Ocean_PostgreSQL: Digital Ocean PostgreSQL ,
Supabase_PostgreSQL: Supabase PostgreSQL ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. ,
Enum:
{
Prefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL. ,
Require: Require SSL connection. If the server does not support SSL, the connection will fail. ,
VerifyCA: Require SSL connection and verify the server certificate against the CA certificate. ,
VerifyFull: Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of source database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of target database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username. ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server. ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: Identifier of the target database server resource. ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server. ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters. ,
Required: False ,
}
{
adminCredentials:
{
Description: Credentials of administrator users for source and target servers. ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for the user of the source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for the user of the target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the name of the user for the source server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the name of the user for the target server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Names of databases to migrate. ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup logical replication on source server, if needed. ,
Enum:
{
True: Logical replication will be set up on the source server. ,
False: Logical replication will not be set up on the source server. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. ,
Enum:
{
True: Databases on the target server can be overwritten when already present. ,
False: Databases on the target server cannot be overwritten when already present. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: Indicates if roles and permissions must be migrated. ,
Enum:
{
True: Roles and permissions will be migrated. ,
False: Roles and permissions will not be migrated. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: Data migration must start right away. ,
False: Data migration must not start right away. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: Cutover must be triggered for the entire migration. ,
False: Cutover must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: Indicates if cancel must be triggered for the entire migration. ,
Enum:
{
True: Cancel must be triggered for the entire migration. ,
False: Cancel must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Migration properties. ,
Required: False ,
}
{
migrationId:
{
Description: Identifier of a migration. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of a migration. ,
Required: False ,
}
{
state:
{
Description: State of migration. ,
Enum:
{
InProgress: Migration is in progress. ,
WaitingForUserAction: Migration is waiting for user action. ,
Canceled: Migration has been canceled. ,
Failed: Migration has failed. ,
Succeeded: Migration has succeeded. ,
ValidationFailed: Validation for migration has failed. ,
CleaningUp: Migration is cleaning up resources. ,
}
,
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: Substate of migration. ,
Enum:
{
PerformingPreRequisiteSteps: Performing pre-requisite steps for migration. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: Waiting for logical replication setup request on source database. ,
WaitingForDBsToMigrateSpecification: Waiting for databases to migrate specification. ,
WaitingForTargetDBOverwriteConfirmation: Waiting for target database overwrite confirmation. ,
WaitingForDataMigrationScheduling: Waiting for data migration scheduling. ,
WaitingForDataMigrationWindow: Waiting for data migration window. ,
MigratingData: Migrating data. ,
WaitingForCutoverTrigger: Waiting for cutover trigger. ,
CompletingMigration: Completing migration. ,
Completed: Migration completed. ,
CancelingRequestedDBMigrations: Canceling requested database migrations. ,
ValidationInProgress: Validation in progress. ,
}
,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Start time (UTC) for validation. ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: End time (UTC) for validation. ,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations. ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of database. ,
Required: False ,
}
string ,
startedOn:
{
Description: Start time of a database level validation. ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End 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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: Identifier of the private endpoint migration instance. ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: Mode used to perform the migration: Online or Offline. ,
Enum:
{
Offline: Offline migration mode. ,
Online: Online migration mode. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: Supported option for a migration. ,
Enum:
{
Validate: Validate the migration without performing it. ,
Migrate: Perform the migration. ,
ValidateAndMigrate: Validate and perform the migration. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: On-premises PostgreSQL server. ,
AWS: Amazon Web Services PostgreSQL server. ,
GCP: Google Cloud Platform PostgreSQL server. ,
AzureVM: Azure Virtual Machine PostgreSQL server. ,
PostgreSQLSingleServer: Azure Database for PostgreSQL single server. ,
AWS_RDS: Amazon RDS for PostgreSQL. ,
AWS_AURORA: Amazon Aurora for PostgreSQL. ,
AWS_EC2: Amazon EC2 for PostgreSQL. ,
GCP_CloudSQL: Google Cloud SQL for PostgreSQL. ,
GCP_AlloyDB: Google Cloud AlloyDB for PostgreSQL. ,
GCP_Compute: Google Compute Engine for PostgreSQL. ,
EDB: EnterpriseDB PostgreSQL server. ,
EDB_Oracle_Server: EnterpriseDB Oracle Server. ,
EDB_PostgreSQL: EnterpriseDB PostgreSQL server. ,
PostgreSQLFlexibleServer: Azure Database for PostgreSQL flexible server. ,
PostgreSQLCosmosDB: .NET Cosmos DB for PostgreSQL ,
Huawei_RDS: Huawei RDS for PostgreSQL ,
Huawei_Compute: Huawei Compute for PostgreSQL ,
Heroku_PostgreSQL: Heroku PostgreSQL ,
Crunchy_PostgreSQL: Crunchy PostgreSQL ,
ApsaraDB_RDS: ApsaraDB RDS for PostgreSQL ,
Digital_Ocean_Droplets: Digital Ocean Droplets for PostgreSQL ,
Digital_Ocean_PostgreSQL: Digital Ocean PostgreSQL ,
Supabase_PostgreSQL: Supabase PostgreSQL ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. ,
Enum:
{
Prefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL. ,
Require: Require SSL connection. If the server does not support SSL, the connection will fail. ,
VerifyCA: Require SSL connection and verify the server certificate against the CA certificate. ,
VerifyFull: Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of source database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of target database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username. ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server. ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: Identifier of the target database server resource. ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server. ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters. ,
Required: False ,
}
{
adminCredentials:
{
Description: Credentials of administrator users for source and target servers. ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for the user of the source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for the user of the target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the name of the user for the source server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the name of the user for the target server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Names of databases to migrate. ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup logical replication on source server, if needed. ,
Enum:
{
True: Logical replication will be set up on the source server. ,
False: Logical replication will not be set up on the source server. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. ,
Enum:
{
True: Databases on the target server can be overwritten when already present. ,
False: Databases on the target server cannot be overwritten when already present. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: Indicates if roles and permissions must be migrated. ,
Enum:
{
True: Roles and permissions will be migrated. ,
False: Roles and permissions will not be migrated. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: Data migration must start right away. ,
False: Data migration must not start right away. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: Cutover must be triggered for the entire migration. ,
False: Cutover must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: Indicates if cancel must be triggered for the entire migration. ,
Enum:
{
True: Cancel must be triggered for the entire migration. ,
False: Cancel must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Migration properties. ,
Required: False ,
}
{
migrationId:
{
Description: Identifier of a migration. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of a migration. ,
Required: False ,
}
{
state:
{
Description: State of migration. ,
Enum:
{
InProgress: Migration is in progress. ,
WaitingForUserAction: Migration is waiting for user action. ,
Canceled: Migration has been canceled. ,
Failed: Migration has failed. ,
Succeeded: Migration has succeeded. ,
ValidationFailed: Validation for migration has failed. ,
CleaningUp: Migration is cleaning up resources. ,
}
,
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: Substate of migration. ,
Enum:
{
PerformingPreRequisiteSteps: Performing pre-requisite steps for migration. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: Waiting for logical replication setup request on source database. ,
WaitingForDBsToMigrateSpecification: Waiting for databases to migrate specification. ,
WaitingForTargetDBOverwriteConfirmation: Waiting for target database overwrite confirmation. ,
WaitingForDataMigrationScheduling: Waiting for data migration scheduling. ,
WaitingForDataMigrationWindow: Waiting for data migration window. ,
MigratingData: Migrating data. ,
WaitingForCutoverTrigger: Waiting for cutover trigger. ,
CompletingMigration: Completing migration. ,
Completed: Migration completed. ,
CancelingRequestedDBMigrations: Canceling requested database migrations. ,
ValidationInProgress: Validation in progress. ,
}
,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Start time (UTC) for validation. ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: End time (UTC) for validation. ,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations. ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of database. ,
Required: False ,
}
string ,
startedOn:
{
Description: Start time of a database level validation. ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End 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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: Identifier of the private endpoint migration instance. ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: Mode used to perform the migration: Online or Offline. ,
Enum:
{
Offline: Offline migration mode. ,
Online: Online migration mode. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: Supported option for a migration. ,
Enum:
{
Validate: Validate the migration without performing it. ,
Migrate: Perform the migration. ,
ValidateAndMigrate: Validate and perform the migration. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: On-premises PostgreSQL server. ,
AWS: Amazon Web Services PostgreSQL server. ,
GCP: Google Cloud Platform PostgreSQL server. ,
AzureVM: Azure Virtual Machine PostgreSQL server. ,
PostgreSQLSingleServer: Azure Database for PostgreSQL single server. ,
AWS_RDS: Amazon RDS for PostgreSQL. ,
AWS_AURORA: Amazon Aurora for PostgreSQL. ,
AWS_EC2: Amazon EC2 for PostgreSQL. ,
GCP_CloudSQL: Google Cloud SQL for PostgreSQL. ,
GCP_AlloyDB: Google Cloud AlloyDB for PostgreSQL. ,
GCP_Compute: Google Compute Engine for PostgreSQL. ,
EDB: EnterpriseDB PostgreSQL server. ,
EDB_Oracle_Server: EnterpriseDB Oracle Server. ,
EDB_PostgreSQL: EnterpriseDB PostgreSQL server. ,
PostgreSQLFlexibleServer: Azure Database for PostgreSQL flexible server. ,
PostgreSQLCosmosDB: .NET Cosmos DB for PostgreSQL ,
Huawei_RDS: Huawei RDS for PostgreSQL ,
Huawei_Compute: Huawei Compute for PostgreSQL ,
Heroku_PostgreSQL: Heroku PostgreSQL ,
Crunchy_PostgreSQL: Crunchy PostgreSQL ,
ApsaraDB_RDS: ApsaraDB RDS for PostgreSQL ,
Digital_Ocean_Droplets: Digital Ocean Droplets for PostgreSQL ,
Digital_Ocean_PostgreSQL: Digital Ocean PostgreSQL ,
Supabase_PostgreSQL: Supabase PostgreSQL ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. ,
Enum:
{
Prefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL. ,
Require: Require SSL connection. If the server does not support SSL, the connection will fail. ,
VerifyCA: Require SSL connection and verify the server certificate against the CA certificate. ,
VerifyFull: Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of source database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of target database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username. ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server. ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: Identifier of the target database server resource. ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server. ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters. ,
Required: False ,
}
{
adminCredentials:
{
Description: Credentials of administrator users for source and target servers. ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for the user of the source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for the user of the target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the name of the user for the source server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the name of the user for the target server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Names of databases to migrate. ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup logical replication on source server, if needed. ,
Enum:
{
True: Logical replication will be set up on the source server. ,
False: Logical replication will not be set up on the source server. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. ,
Enum:
{
True: Databases on the target server can be overwritten when already present. ,
False: Databases on the target server cannot be overwritten when already present. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: Indicates if roles and permissions must be migrated. ,
Enum:
{
True: Roles and permissions will be migrated. ,
False: Roles and permissions will not be migrated. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: Data migration must start right away. ,
False: Data migration must not start right away. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: Cutover must be triggered for the entire migration. ,
False: Cutover must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: Indicates if cancel must be triggered for the entire migration. ,
Enum:
{
True: Cancel must be triggered for the entire migration. ,
False: Cancel must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases 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 (updated)
Description :  Gets information about a migration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migrations_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "currentStatus": [
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "InProgress",
                      "Migration is in progress."
                    ],
                    [
                      "WaitingForUserAction",
                      "Migration is waiting for user action."
                    ],
                    [
                      "Canceled",
                      "Migration has been canceled."
                    ],
                    [
                      "Failed",
                      "Migration has failed."
                    ],
                    [
                      "Succeeded",
                      "Migration has succeeded."
                    ],
                    [
                      "ValidationFailed",
                      "Validation for migration has failed."
                    ],
                    [
                      "CleaningUp",
                      "Migration is cleaning up resources."
                    ]
                  ],
                  "old": [
                    [
                      "InProgress",
                      ""
                    ],
                    [
                      "WaitingForUserAction",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "ValidationFailed",
                      ""
                    ],
                    [
                      "CleaningUp",
                      ""
                    ]
                  ]
                }
              },
              {
                "currentSubStateDetails": [
                  {
                    "#name": "currentSubState",
                    "Enum": {
                      "new": [
                        [
                          "PerformingPreRequisiteSteps",
                          "Performing pre-requisite steps for migration."
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          "Waiting for logical replication setup request on source database."
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          "Waiting for databases to migrate specification."
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          "Waiting for target database overwrite confirmation."
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          "Waiting for data migration scheduling."
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          "Waiting for data migration window."
                        ],
                        [
                          "MigratingData",
                          "Migrating data."
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          "Waiting for cutover trigger."
                        ],
                        [
                          "CompletingMigration",
                          "Completing migration."
                        ],
                        [
                          "Completed",
                          "Migration completed."
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          "Canceling requested database migrations."
                        ],
                        [
                          "ValidationInProgress",
                          "Validation in progress."
                        ]
                      ],
                      "old": [
                        [
                          "PerformingPreRequisiteSteps",
                          ""
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          ""
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          ""
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          ""
                        ],
                        [
                          "MigratingData",
                          ""
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          ""
                        ],
                        [
                          "CompletingMigration",
                          ""
                        ],
                        [
                          "Completed",
                          ""
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          ""
                        ],
                        [
                          "ValidationInProgress",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "validationDetails": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Failed",
                              "Validation has failed."
                            ],
                            [
                              "Succeeded",
                              "Validation has succeeded."
                            ],
                            [
                              "Warning",
                              "Validation has succeeded with warnings."
                            ]
                          ],
                          "old": [
                            [
                              "Failed",
                              ""
                            ],
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Warning",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "serverLevelValidationDetails": {
                          "$properties": [
                            {
                              "#name": "state",
                              "Enum": {
                                "new": [
                                  [
                                    "Failed",
                                    "Validation has failed."
                                  ],
                                  [
                                    "Succeeded",
                                    "Validation has succeeded."
                                  ],
                                  [
                                    "Warning",
                                    "Validation has succeeded with warnings."
                                  ]
                                ],
                                "old": [
                                  [
                                    "Failed",
                                    ""
                                  ],
                                  [
                                    "Succeeded",
                                    ""
                                  ],
                                  [
                                    "Warning",
                                    ""
                                  ]
                                ]
                              }
                            },
                            {
                              "messages": {
                                "$properties": [
                                  {
                                    "#name": "state",
                                    "Enum": {
                                      "new": [
                                        [
                                          "Failed",
                                          "Validation has failed."
                                        ],
                                        [
                                          "Succeeded",
                                          "Validation has succeeded."
                                        ],
                                        [
                                          "Warning",
                                          "Validation has succeeded with warnings."
                                        ]
                                      ],
                                      "old": [
                                        [
                                          "Failed",
                                          ""
                                        ],
                                        [
                                          "Succeeded",
                                          ""
                                        ],
                                        [
                                          "Warning",
                                          ""
                                        ]
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "dbLevelValidationDetails": {
                          "$properties": {
                            "summary": {
                              "$properties": [
                                {
                                  "#name": "state",
                                  "Enum": {
                                    "new": [
                                      [
                                        "Failed",
                                        "Validation has failed."
                                      ],
                                      [
                                        "Succeeded",
                                        "Validation has succeeded."
                                      ],
                                      [
                                        "Warning",
                                        "Validation has succeeded with warnings."
                                      ]
                                    ],
                                    "old": [
                                      [
                                        "Failed",
                                        ""
                                      ],
                                      [
                                        "Succeeded",
                                        ""
                                      ],
                                      [
                                        "Warning",
                                        ""
                                      ]
                                    ]
                                  }
                                },
                                {
                                  "messages": {
                                    "$properties": [
                                      {
                                        "#name": "state",
                                        "Enum": {
                                          "new": [
                                            [
                                              "Failed",
                                              "Validation has failed."
                                            ],
                                            [
                                              "Succeeded",
                                              "Validation has succeeded."
                                            ],
                                            [
                                              "Warning",
                                              "Validation has succeeded with warnings."
                                            ]
                                          ],
                                          "old": [
                                            [
                                              "Failed",
                                              ""
                                            ],
                                            [
                                              "Succeeded",
                                              ""
                                            ],
                                            [
                                              "Warning",
                                              ""
                                            ]
                                          ]
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "migrationMode",
            "Enum": {
              "new": [
                [
                  "Offline",
                  "Offline migration mode."
                ],
                [
                  "Online",
                  "Online migration mode."
                ]
              ],
              "old": [
                [
                  "Offline",
                  ""
                ],
                [
                  "Online",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrationOption",
            "Enum": {
              "new": [
                [
                  "Validate",
                  "Validate the migration without performing it."
                ],
                [
                  "Migrate",
                  "Perform the migration."
                ],
                [
                  "ValidateAndMigrate",
                  "Validate and perform the migration."
                ]
              ],
              "old": [
                [
                  "Validate",
                  ""
                ],
                [
                  "Migrate",
                  ""
                ],
                [
                  "ValidateAndMigrate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sourceType",
            "Enum": {
              "new": [
                [
                  "OnPremises",
                  "On-premises PostgreSQL server."
                ],
                [
                  "AWS",
                  "Amazon Web Services PostgreSQL server."
                ],
                [
                  "GCP",
                  "Google Cloud Platform PostgreSQL server."
                ],
                [
                  "AzureVM",
                  "Azure Virtual Machine PostgreSQL server."
                ],
                [
                  "PostgreSQLSingleServer",
                  "Azure Database for PostgreSQL single server."
                ],
                [
                  "AWS_RDS",
                  "Amazon RDS for PostgreSQL."
                ],
                [
                  "AWS_AURORA",
                  "Amazon Aurora for PostgreSQL."
                ],
                [
                  "AWS_EC2",
                  "Amazon EC2 for PostgreSQL."
                ],
                [
                  "GCP_CloudSQL",
                  "Google Cloud SQL for PostgreSQL."
                ],
                [
                  "GCP_AlloyDB",
                  "Google Cloud AlloyDB for PostgreSQL."
                ],
                [
                  "GCP_Compute",
                  "Google Compute Engine for PostgreSQL."
                ],
                [
                  "EDB",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "EDB_Oracle_Server",
                  "EnterpriseDB Oracle Server."
                ],
                [
                  "EDB_PostgreSQL",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "PostgreSQLFlexibleServer",
                  "Azure Database for PostgreSQL flexible server."
                ],
                [
                  "PostgreSQLCosmosDB",
                  ".NET Cosmos DB for PostgreSQL"
                ],
                [
                  "Huawei_RDS",
                  "Huawei RDS for PostgreSQL"
                ],
                [
                  "Huawei_Compute",
                  "Huawei Compute for PostgreSQL"
                ],
                [
                  "Heroku_PostgreSQL",
                  "Heroku PostgreSQL"
                ],
                [
                  "Crunchy_PostgreSQL",
                  "Crunchy PostgreSQL"
                ],
                [
                  "ApsaraDB_RDS",
                  "ApsaraDB RDS for PostgreSQL"
                ],
                [
                  "Digital_Ocean_Droplets",
                  "Digital Ocean Droplets for PostgreSQL"
                ],
                [
                  "Digital_Ocean_PostgreSQL",
                  "Digital Ocean PostgreSQL"
                ],
                [
                  "Supabase_PostgreSQL",
                  "Supabase PostgreSQL"
                ]
              ],
              "old": [
                [
                  "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",
                  ""
                ],
                [
                  "Supabase_PostgreSQL",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sslMode",
            "Enum": {
              "new": [
                [
                  "Prefer",
                  "Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL."
                ],
                [
                  "Require",
                  "Require SSL connection. If the server does not support SSL, the connection will fail."
                ],
                [
                  "VerifyCA",
                  "Require SSL connection and verify the server certificate against the CA certificate."
                ],
                [
                  "VerifyFull",
                  "Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate."
                ]
              ],
              "old": [
                [
                  "Prefer",
                  ""
                ],
                [
                  "Require",
                  ""
                ],
                [
                  "VerifyCA",
                  ""
                ],
                [
                  "VerifyFull",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
            "Enum": {
              "new": [
                [
                  "True",
                  "Logical replication will be set up on the source server."
                ],
                [
                  "False",
                  "Logical replication will not be set up on the source server."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "overwriteDbsInTarget",
            "Enum": {
              "new": [
                [
                  "True",
                  "Databases on the target server can be overwritten when already present."
                ],
                [
                  "False",
                  "Databases on the target server cannot be overwritten when already present."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrateRoles",
            "Enum": {
              "new": [
                [
                  "True",
                  "Roles and permissions will be migrated."
                ],
                [
                  "False",
                  "Roles and permissions will not be migrated."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "startDataMigration",
            "Enum": {
              "new": [
                [
                  "True",
                  "Data migration must start right away."
                ],
                [
                  "False",
                  "Data migration must not start right away."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "triggerCutover",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cutover must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cutover must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "cancel",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cancel must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cancel must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrations/{migrationName}
{
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 ,
migrationName:
{
Description: Name of migration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Migration properties. ,
Required: False ,
}
{
migrationId:
{
Description: Identifier of a migration. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of a migration. ,
Required: False ,
}
{
state:
{
Description: State of migration. ,
Enum:
{
InProgress: Migration is in progress. ,
WaitingForUserAction: Migration is waiting for user action. ,
Canceled: Migration has been canceled. ,
Failed: Migration has failed. ,
Succeeded: Migration has succeeded. ,
ValidationFailed: Validation for migration has failed. ,
CleaningUp: Migration is cleaning up resources. ,
}
,
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: Substate of migration. ,
Enum:
{
PerformingPreRequisiteSteps: Performing pre-requisite steps for migration. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: Waiting for logical replication setup request on source database. ,
WaitingForDBsToMigrateSpecification: Waiting for databases to migrate specification. ,
WaitingForTargetDBOverwriteConfirmation: Waiting for target database overwrite confirmation. ,
WaitingForDataMigrationScheduling: Waiting for data migration scheduling. ,
WaitingForDataMigrationWindow: Waiting for data migration window. ,
MigratingData: Migrating data. ,
WaitingForCutoverTrigger: Waiting for cutover trigger. ,
CompletingMigration: Completing migration. ,
Completed: Migration completed. ,
CancelingRequestedDBMigrations: Canceling requested database migrations. ,
ValidationInProgress: Validation in progress. ,
}
,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Start time (UTC) for validation. ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: End time (UTC) for validation. ,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations. ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of database. ,
Required: False ,
}
string ,
startedOn:
{
Description: Start time of a database level validation. ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End 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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: Identifier of the private endpoint migration instance. ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: Mode used to perform the migration: Online or Offline. ,
Enum:
{
Offline: Offline migration mode. ,
Online: Online migration mode. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: Supported option for a migration. ,
Enum:
{
Validate: Validate the migration without performing it. ,
Migrate: Perform the migration. ,
ValidateAndMigrate: Validate and perform the migration. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: On-premises PostgreSQL server. ,
AWS: Amazon Web Services PostgreSQL server. ,
GCP: Google Cloud Platform PostgreSQL server. ,
AzureVM: Azure Virtual Machine PostgreSQL server. ,
PostgreSQLSingleServer: Azure Database for PostgreSQL single server. ,
AWS_RDS: Amazon RDS for PostgreSQL. ,
AWS_AURORA: Amazon Aurora for PostgreSQL. ,
AWS_EC2: Amazon EC2 for PostgreSQL. ,
GCP_CloudSQL: Google Cloud SQL for PostgreSQL. ,
GCP_AlloyDB: Google Cloud AlloyDB for PostgreSQL. ,
GCP_Compute: Google Compute Engine for PostgreSQL. ,
EDB: EnterpriseDB PostgreSQL server. ,
EDB_Oracle_Server: EnterpriseDB Oracle Server. ,
EDB_PostgreSQL: EnterpriseDB PostgreSQL server. ,
PostgreSQLFlexibleServer: Azure Database for PostgreSQL flexible server. ,
PostgreSQLCosmosDB: .NET Cosmos DB for PostgreSQL ,
Huawei_RDS: Huawei RDS for PostgreSQL ,
Huawei_Compute: Huawei Compute for PostgreSQL ,
Heroku_PostgreSQL: Heroku PostgreSQL ,
Crunchy_PostgreSQL: Crunchy PostgreSQL ,
ApsaraDB_RDS: ApsaraDB RDS for PostgreSQL ,
Digital_Ocean_Droplets: Digital Ocean Droplets for PostgreSQL ,
Digital_Ocean_PostgreSQL: Digital Ocean PostgreSQL ,
Supabase_PostgreSQL: Supabase PostgreSQL ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. ,
Enum:
{
Prefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL. ,
Require: Require SSL connection. If the server does not support SSL, the connection will fail. ,
VerifyCA: Require SSL connection and verify the server certificate against the CA certificate. ,
VerifyFull: Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of source database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of target database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username. ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server. ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: Identifier of the target database server resource. ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server. ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters. ,
Required: False ,
}
{
adminCredentials:
{
Description: Credentials of administrator users for source and target servers. ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for the user of the source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for the user of the target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the name of the user for the source server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the name of the user for the target server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Names of databases to migrate. ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup logical replication on source server, if needed. ,
Enum:
{
True: Logical replication will be set up on the source server. ,
False: Logical replication will not be set up on the source server. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. ,
Enum:
{
True: Databases on the target server can be overwritten when already present. ,
False: Databases on the target server cannot be overwritten when already present. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: Indicates if roles and permissions must be migrated. ,
Enum:
{
True: Roles and permissions will be migrated. ,
False: Roles and permissions will not be migrated. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: Data migration must start right away. ,
False: Data migration must not start right away. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: Cutover must be triggered for the entire migration. ,
False: Cutover must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: Indicates if cancel must be triggered for the entire migration. ,
Enum:
{
True: Cancel must be triggered for the entire migration. ,
False: Cancel must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases 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 (updated)
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 ¶

⚶ Changes

{
  "#id": "Migrations_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
            "Enum": {
              "new": [
                [
                  "True",
                  "Logical replication will be set up on the source server."
                ],
                [
                  "False",
                  "Logical replication will not be set up on the source server."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "overwriteDbsInTarget",
            "Enum": {
              "new": [
                [
                  "True",
                  "Databases on the target server can be overwritten when already present."
                ],
                [
                  "False",
                  "Databases on the target server cannot be overwritten when already present."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrateRoles",
            "Enum": {
              "new": [
                [
                  "True",
                  "Roles and permissions will be migrated."
                ],
                [
                  "False",
                  "Roles and permissions will not be migrated."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "startDataMigration",
            "Enum": {
              "new": [
                [
                  "True",
                  "Data migration must start right away."
                ],
                [
                  "False",
                  "Data migration must not start right away."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "triggerCutover",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cutover must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cutover must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "cancel",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cancel must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cancel must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrationMode",
            "Enum": {
              "new": [
                [
                  "Offline",
                  "Offline migration mode."
                ],
                [
                  "Online",
                  "Online migration mode."
                ]
              ],
              "old": [
                [
                  "Offline",
                  ""
                ],
                [
                  "Online",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "currentStatus": [
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "InProgress",
                      "Migration is in progress."
                    ],
                    [
                      "WaitingForUserAction",
                      "Migration is waiting for user action."
                    ],
                    [
                      "Canceled",
                      "Migration has been canceled."
                    ],
                    [
                      "Failed",
                      "Migration has failed."
                    ],
                    [
                      "Succeeded",
                      "Migration has succeeded."
                    ],
                    [
                      "ValidationFailed",
                      "Validation for migration has failed."
                    ],
                    [
                      "CleaningUp",
                      "Migration is cleaning up resources."
                    ]
                  ],
                  "old": [
                    [
                      "InProgress",
                      ""
                    ],
                    [
                      "WaitingForUserAction",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "ValidationFailed",
                      ""
                    ],
                    [
                      "CleaningUp",
                      ""
                    ]
                  ]
                }
              },
              {
                "currentSubStateDetails": [
                  {
                    "#name": "currentSubState",
                    "Enum": {
                      "new": [
                        [
                          "PerformingPreRequisiteSteps",
                          "Performing pre-requisite steps for migration."
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          "Waiting for logical replication setup request on source database."
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          "Waiting for databases to migrate specification."
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          "Waiting for target database overwrite confirmation."
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          "Waiting for data migration scheduling."
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          "Waiting for data migration window."
                        ],
                        [
                          "MigratingData",
                          "Migrating data."
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          "Waiting for cutover trigger."
                        ],
                        [
                          "CompletingMigration",
                          "Completing migration."
                        ],
                        [
                          "Completed",
                          "Migration completed."
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          "Canceling requested database migrations."
                        ],
                        [
                          "ValidationInProgress",
                          "Validation in progress."
                        ]
                      ],
                      "old": [
                        [
                          "PerformingPreRequisiteSteps",
                          ""
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          ""
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          ""
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          ""
                        ],
                        [
                          "MigratingData",
                          ""
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          ""
                        ],
                        [
                          "CompletingMigration",
                          ""
                        ],
                        [
                          "Completed",
                          ""
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          ""
                        ],
                        [
                          "ValidationInProgress",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "validationDetails": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Failed",
                              "Validation has failed."
                            ],
                            [
                              "Succeeded",
                              "Validation has succeeded."
                            ],
                            [
                              "Warning",
                              "Validation has succeeded with warnings."
                            ]
                          ],
                          "old": [
                            [
                              "Failed",
                              ""
                            ],
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Warning",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "serverLevelValidationDetails": {
                          "$properties": [
                            {
                              "#name": "state",
                              "Enum": {
                                "new": [
                                  [
                                    "Failed",
                                    "Validation has failed."
                                  ],
                                  [
                                    "Succeeded",
                                    "Validation has succeeded."
                                  ],
                                  [
                                    "Warning",
                                    "Validation has succeeded with warnings."
                                  ]
                                ],
                                "old": [
                                  [
                                    "Failed",
                                    ""
                                  ],
                                  [
                                    "Succeeded",
                                    ""
                                  ],
                                  [
                                    "Warning",
                                    ""
                                  ]
                                ]
                              }
                            },
                            {
                              "messages": {
                                "$properties": [
                                  {
                                    "#name": "state",
                                    "Enum": {
                                      "new": [
                                        [
                                          "Failed",
                                          "Validation has failed."
                                        ],
                                        [
                                          "Succeeded",
                                          "Validation has succeeded."
                                        ],
                                        [
                                          "Warning",
                                          "Validation has succeeded with warnings."
                                        ]
                                      ],
                                      "old": [
                                        [
                                          "Failed",
                                          ""
                                        ],
                                        [
                                          "Succeeded",
                                          ""
                                        ],
                                        [
                                          "Warning",
                                          ""
                                        ]
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "dbLevelValidationDetails": {
                          "$properties": {
                            "summary": {
                              "$properties": [
                                {
                                  "#name": "state",
                                  "Enum": {
                                    "new": [
                                      [
                                        "Failed",
                                        "Validation has failed."
                                      ],
                                      [
                                        "Succeeded",
                                        "Validation has succeeded."
                                      ],
                                      [
                                        "Warning",
                                        "Validation has succeeded with warnings."
                                      ]
                                    ],
                                    "old": [
                                      [
                                        "Failed",
                                        ""
                                      ],
                                      [
                                        "Succeeded",
                                        ""
                                      ],
                                      [
                                        "Warning",
                                        ""
                                      ]
                                    ]
                                  }
                                },
                                {
                                  "messages": {
                                    "$properties": [
                                      {
                                        "#name": "state",
                                        "Enum": {
                                          "new": [
                                            [
                                              "Failed",
                                              "Validation has failed."
                                            ],
                                            [
                                              "Succeeded",
                                              "Validation has succeeded."
                                            ],
                                            [
                                              "Warning",
                                              "Validation has succeeded with warnings."
                                            ]
                                          ],
                                          "old": [
                                            [
                                              "Failed",
                                              ""
                                            ],
                                            [
                                              "Succeeded",
                                              ""
                                            ],
                                            [
                                              "Warning",
                                              ""
                                            ]
                                          ]
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "migrationMode",
            "Enum": {
              "new": [
                [
                  "Offline",
                  "Offline migration mode."
                ],
                [
                  "Online",
                  "Online migration mode."
                ]
              ],
              "old": [
                [
                  "Offline",
                  ""
                ],
                [
                  "Online",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrationOption",
            "Enum": {
              "new": [
                [
                  "Validate",
                  "Validate the migration without performing it."
                ],
                [
                  "Migrate",
                  "Perform the migration."
                ],
                [
                  "ValidateAndMigrate",
                  "Validate and perform the migration."
                ]
              ],
              "old": [
                [
                  "Validate",
                  ""
                ],
                [
                  "Migrate",
                  ""
                ],
                [
                  "ValidateAndMigrate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sourceType",
            "Enum": {
              "new": [
                [
                  "OnPremises",
                  "On-premises PostgreSQL server."
                ],
                [
                  "AWS",
                  "Amazon Web Services PostgreSQL server."
                ],
                [
                  "GCP",
                  "Google Cloud Platform PostgreSQL server."
                ],
                [
                  "AzureVM",
                  "Azure Virtual Machine PostgreSQL server."
                ],
                [
                  "PostgreSQLSingleServer",
                  "Azure Database for PostgreSQL single server."
                ],
                [
                  "AWS_RDS",
                  "Amazon RDS for PostgreSQL."
                ],
                [
                  "AWS_AURORA",
                  "Amazon Aurora for PostgreSQL."
                ],
                [
                  "AWS_EC2",
                  "Amazon EC2 for PostgreSQL."
                ],
                [
                  "GCP_CloudSQL",
                  "Google Cloud SQL for PostgreSQL."
                ],
                [
                  "GCP_AlloyDB",
                  "Google Cloud AlloyDB for PostgreSQL."
                ],
                [
                  "GCP_Compute",
                  "Google Compute Engine for PostgreSQL."
                ],
                [
                  "EDB",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "EDB_Oracle_Server",
                  "EnterpriseDB Oracle Server."
                ],
                [
                  "EDB_PostgreSQL",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "PostgreSQLFlexibleServer",
                  "Azure Database for PostgreSQL flexible server."
                ],
                [
                  "PostgreSQLCosmosDB",
                  ".NET Cosmos DB for PostgreSQL"
                ],
                [
                  "Huawei_RDS",
                  "Huawei RDS for PostgreSQL"
                ],
                [
                  "Huawei_Compute",
                  "Huawei Compute for PostgreSQL"
                ],
                [
                  "Heroku_PostgreSQL",
                  "Heroku PostgreSQL"
                ],
                [
                  "Crunchy_PostgreSQL",
                  "Crunchy PostgreSQL"
                ],
                [
                  "ApsaraDB_RDS",
                  "ApsaraDB RDS for PostgreSQL"
                ],
                [
                  "Digital_Ocean_Droplets",
                  "Digital Ocean Droplets for PostgreSQL"
                ],
                [
                  "Digital_Ocean_PostgreSQL",
                  "Digital Ocean PostgreSQL"
                ],
                [
                  "Supabase_PostgreSQL",
                  "Supabase PostgreSQL"
                ]
              ],
              "old": [
                [
                  "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",
                  ""
                ],
                [
                  "Supabase_PostgreSQL",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sslMode",
            "Enum": {
              "new": [
                [
                  "Prefer",
                  "Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL."
                ],
                [
                  "Require",
                  "Require SSL connection. If the server does not support SSL, the connection will fail."
                ],
                [
                  "VerifyCA",
                  "Require SSL connection and verify the server certificate against the CA certificate."
                ],
                [
                  "VerifyFull",
                  "Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate."
                ]
              ],
              "old": [
                [
                  "Prefer",
                  ""
                ],
                [
                  "Require",
                  ""
                ],
                [
                  "VerifyCA",
                  ""
                ],
                [
                  "VerifyFull",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
            "Enum": {
              "new": [
                [
                  "True",
                  "Logical replication will be set up on the source server."
                ],
                [
                  "False",
                  "Logical replication will not be set up on the source server."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "overwriteDbsInTarget",
            "Enum": {
              "new": [
                [
                  "True",
                  "Databases on the target server can be overwritten when already present."
                ],
                [
                  "False",
                  "Databases on the target server cannot be overwritten when already present."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrateRoles",
            "Enum": {
              "new": [
                [
                  "True",
                  "Roles and permissions will be migrated."
                ],
                [
                  "False",
                  "Roles and permissions will not be migrated."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "startDataMigration",
            "Enum": {
              "new": [
                [
                  "True",
                  "Data migration must start right away."
                ],
                [
                  "False",
                  "Data migration must not start right away."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "triggerCutover",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cutover must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cutover must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "cancel",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cancel must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cancel must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrations/{migrationName}
{
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 ,
migrationName:
{
Description: Name of migration. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to update an existing migration. ,
Required: True ,
}
{
properties:
{
Description: Migration properties. ,
Required: False ,
}
{
sourceDbServerResourceId:
{
Description: Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username. ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server. ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server. ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters. ,
Required: False ,
}
{
adminCredentials:
{
Description: Credentials of administrator users for source and target servers. ,
Required: False ,
}
{
sourceServerPassword:
{
Description: Password for the user of the source server. ,
Required: False ,
}
string ,
targetServerPassword:
{
Description: Password for the user of the target server. ,
Required: False ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the name of the user for the source server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the name of the user for the target server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Names of databases to migrate. ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup logical replication on source server, if needed. ,
Enum:
{
True: Logical replication will be set up on the source server. ,
False: Logical replication will not be set up on the source server. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. ,
Enum:
{
True: Databases on the target server can be overwritten when already present. ,
False: Databases on the target server cannot be overwritten when already present. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: Indicates if roles and permissions must be migrated. ,
Enum:
{
True: Roles and permissions will be migrated. ,
False: Roles and permissions will not be migrated. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: Data migration must start right away. ,
False: Data migration must not start right away. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: Cutover must be triggered for the entire migration. ,
False: Cutover must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: Indicates if cancel must be triggered for the entire migration. ,
Enum:
{
True: Cancel must be triggered for the entire migration. ,
False: Cancel must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
migrationMode:
{
Description: Mode used to perform the migration: Online or Offline. ,
Enum:
{
Offline: Offline migration mode. ,
Online: Online migration mode. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Migration properties. ,
Required: False ,
}
{
migrationId:
{
Description: Identifier of a migration. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of a migration. ,
Required: False ,
}
{
state:
{
Description: State of migration. ,
Enum:
{
InProgress: Migration is in progress. ,
WaitingForUserAction: Migration is waiting for user action. ,
Canceled: Migration has been canceled. ,
Failed: Migration has failed. ,
Succeeded: Migration has succeeded. ,
ValidationFailed: Validation for migration has failed. ,
CleaningUp: Migration is cleaning up resources. ,
}
,
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: Substate of migration. ,
Enum:
{
PerformingPreRequisiteSteps: Performing pre-requisite steps for migration. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: Waiting for logical replication setup request on source database. ,
WaitingForDBsToMigrateSpecification: Waiting for databases to migrate specification. ,
WaitingForTargetDBOverwriteConfirmation: Waiting for target database overwrite confirmation. ,
WaitingForDataMigrationScheduling: Waiting for data migration scheduling. ,
WaitingForDataMigrationWindow: Waiting for data migration window. ,
MigratingData: Migrating data. ,
WaitingForCutoverTrigger: Waiting for cutover trigger. ,
CompletingMigration: Completing migration. ,
Completed: Migration completed. ,
CancelingRequestedDBMigrations: Canceling requested database migrations. ,
ValidationInProgress: Validation in progress. ,
}
,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Start time (UTC) for validation. ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: End time (UTC) for validation. ,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations. ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of database. ,
Required: False ,
}
string ,
startedOn:
{
Description: Start time of a database level validation. ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End 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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: Identifier of the private endpoint migration instance. ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: Mode used to perform the migration: Online or Offline. ,
Enum:
{
Offline: Offline migration mode. ,
Online: Online migration mode. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: Supported option for a migration. ,
Enum:
{
Validate: Validate the migration without performing it. ,
Migrate: Perform the migration. ,
ValidateAndMigrate: Validate and perform the migration. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: On-premises PostgreSQL server. ,
AWS: Amazon Web Services PostgreSQL server. ,
GCP: Google Cloud Platform PostgreSQL server. ,
AzureVM: Azure Virtual Machine PostgreSQL server. ,
PostgreSQLSingleServer: Azure Database for PostgreSQL single server. ,
AWS_RDS: Amazon RDS for PostgreSQL. ,
AWS_AURORA: Amazon Aurora for PostgreSQL. ,
AWS_EC2: Amazon EC2 for PostgreSQL. ,
GCP_CloudSQL: Google Cloud SQL for PostgreSQL. ,
GCP_AlloyDB: Google Cloud AlloyDB for PostgreSQL. ,
GCP_Compute: Google Compute Engine for PostgreSQL. ,
EDB: EnterpriseDB PostgreSQL server. ,
EDB_Oracle_Server: EnterpriseDB Oracle Server. ,
EDB_PostgreSQL: EnterpriseDB PostgreSQL server. ,
PostgreSQLFlexibleServer: Azure Database for PostgreSQL flexible server. ,
PostgreSQLCosmosDB: .NET Cosmos DB for PostgreSQL ,
Huawei_RDS: Huawei RDS for PostgreSQL ,
Huawei_Compute: Huawei Compute for PostgreSQL ,
Heroku_PostgreSQL: Heroku PostgreSQL ,
Crunchy_PostgreSQL: Crunchy PostgreSQL ,
ApsaraDB_RDS: ApsaraDB RDS for PostgreSQL ,
Digital_Ocean_Droplets: Digital Ocean Droplets for PostgreSQL ,
Digital_Ocean_PostgreSQL: Digital Ocean PostgreSQL ,
Supabase_PostgreSQL: Supabase PostgreSQL ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. ,
Enum:
{
Prefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL. ,
Require: Require SSL connection. If the server does not support SSL, the connection will fail. ,
VerifyCA: Require SSL connection and verify the server certificate against the CA certificate. ,
VerifyFull: Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of source database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of target database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username. ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server. ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: Identifier of the target database server resource. ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server. ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters. ,
Required: False ,
}
{
adminCredentials:
{
Description: Credentials of administrator users for source and target servers. ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for the user of the source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for the user of the target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the name of the user for the source server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the name of the user for the target server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Names of databases to migrate. ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup logical replication on source server, if needed. ,
Enum:
{
True: Logical replication will be set up on the source server. ,
False: Logical replication will not be set up on the source server. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. ,
Enum:
{
True: Databases on the target server can be overwritten when already present. ,
False: Databases on the target server cannot be overwritten when already present. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: Indicates if roles and permissions must be migrated. ,
Enum:
{
True: Roles and permissions will be migrated. ,
False: Roles and permissions will not be migrated. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: Data migration must start right away. ,
False: Data migration must not start right away. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: Cutover must be triggered for the entire migration. ,
False: Cutover must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: Indicates if cancel must be triggered for the entire migration. ,
Enum:
{
True: Cancel must be triggered for the entire migration. ,
False: Cancel must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases 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_Cancel (updated)
Description :  Cancels an active migration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migrations_Cancel",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "currentStatus": [
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "InProgress",
                      "Migration is in progress."
                    ],
                    [
                      "WaitingForUserAction",
                      "Migration is waiting for user action."
                    ],
                    [
                      "Canceled",
                      "Migration has been canceled."
                    ],
                    [
                      "Failed",
                      "Migration has failed."
                    ],
                    [
                      "Succeeded",
                      "Migration has succeeded."
                    ],
                    [
                      "ValidationFailed",
                      "Validation for migration has failed."
                    ],
                    [
                      "CleaningUp",
                      "Migration is cleaning up resources."
                    ]
                  ],
                  "old": [
                    [
                      "InProgress",
                      ""
                    ],
                    [
                      "WaitingForUserAction",
                      ""
                    ],
                    [
                      "Canceled",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ],
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "ValidationFailed",
                      ""
                    ],
                    [
                      "CleaningUp",
                      ""
                    ]
                  ]
                }
              },
              {
                "currentSubStateDetails": [
                  {
                    "#name": "currentSubState",
                    "Enum": {
                      "new": [
                        [
                          "PerformingPreRequisiteSteps",
                          "Performing pre-requisite steps for migration."
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          "Waiting for logical replication setup request on source database."
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          "Waiting for databases to migrate specification."
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          "Waiting for target database overwrite confirmation."
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          "Waiting for data migration scheduling."
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          "Waiting for data migration window."
                        ],
                        [
                          "MigratingData",
                          "Migrating data."
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          "Waiting for cutover trigger."
                        ],
                        [
                          "CompletingMigration",
                          "Completing migration."
                        ],
                        [
                          "Completed",
                          "Migration completed."
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          "Canceling requested database migrations."
                        ],
                        [
                          "ValidationInProgress",
                          "Validation in progress."
                        ]
                      ],
                      "old": [
                        [
                          "PerformingPreRequisiteSteps",
                          ""
                        ],
                        [
                          "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                          ""
                        ],
                        [
                          "WaitingForDBsToMigrateSpecification",
                          ""
                        ],
                        [
                          "WaitingForTargetDBOverwriteConfirmation",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationScheduling",
                          ""
                        ],
                        [
                          "WaitingForDataMigrationWindow",
                          ""
                        ],
                        [
                          "MigratingData",
                          ""
                        ],
                        [
                          "WaitingForCutoverTrigger",
                          ""
                        ],
                        [
                          "CompletingMigration",
                          ""
                        ],
                        [
                          "Completed",
                          ""
                        ],
                        [
                          "CancelingRequestedDBMigrations",
                          ""
                        ],
                        [
                          "ValidationInProgress",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "validationDetails": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Failed",
                              "Validation has failed."
                            ],
                            [
                              "Succeeded",
                              "Validation has succeeded."
                            ],
                            [
                              "Warning",
                              "Validation has succeeded with warnings."
                            ]
                          ],
                          "old": [
                            [
                              "Failed",
                              ""
                            ],
                            [
                              "Succeeded",
                              ""
                            ],
                            [
                              "Warning",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "serverLevelValidationDetails": {
                          "$properties": [
                            {
                              "#name": "state",
                              "Enum": {
                                "new": [
                                  [
                                    "Failed",
                                    "Validation has failed."
                                  ],
                                  [
                                    "Succeeded",
                                    "Validation has succeeded."
                                  ],
                                  [
                                    "Warning",
                                    "Validation has succeeded with warnings."
                                  ]
                                ],
                                "old": [
                                  [
                                    "Failed",
                                    ""
                                  ],
                                  [
                                    "Succeeded",
                                    ""
                                  ],
                                  [
                                    "Warning",
                                    ""
                                  ]
                                ]
                              }
                            },
                            {
                              "messages": {
                                "$properties": [
                                  {
                                    "#name": "state",
                                    "Enum": {
                                      "new": [
                                        [
                                          "Failed",
                                          "Validation has failed."
                                        ],
                                        [
                                          "Succeeded",
                                          "Validation has succeeded."
                                        ],
                                        [
                                          "Warning",
                                          "Validation has succeeded with warnings."
                                        ]
                                      ],
                                      "old": [
                                        [
                                          "Failed",
                                          ""
                                        ],
                                        [
                                          "Succeeded",
                                          ""
                                        ],
                                        [
                                          "Warning",
                                          ""
                                        ]
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "dbLevelValidationDetails": {
                          "$properties": {
                            "summary": {
                              "$properties": [
                                {
                                  "#name": "state",
                                  "Enum": {
                                    "new": [
                                      [
                                        "Failed",
                                        "Validation has failed."
                                      ],
                                      [
                                        "Succeeded",
                                        "Validation has succeeded."
                                      ],
                                      [
                                        "Warning",
                                        "Validation has succeeded with warnings."
                                      ]
                                    ],
                                    "old": [
                                      [
                                        "Failed",
                                        ""
                                      ],
                                      [
                                        "Succeeded",
                                        ""
                                      ],
                                      [
                                        "Warning",
                                        ""
                                      ]
                                    ]
                                  }
                                },
                                {
                                  "messages": {
                                    "$properties": [
                                      {
                                        "#name": "state",
                                        "Enum": {
                                          "new": [
                                            [
                                              "Failed",
                                              "Validation has failed."
                                            ],
                                            [
                                              "Succeeded",
                                              "Validation has succeeded."
                                            ],
                                            [
                                              "Warning",
                                              "Validation has succeeded with warnings."
                                            ]
                                          ],
                                          "old": [
                                            [
                                              "Failed",
                                              ""
                                            ],
                                            [
                                              "Succeeded",
                                              ""
                                            ],
                                            [
                                              "Warning",
                                              ""
                                            ]
                                          ]
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "migrationMode",
            "Enum": {
              "new": [
                [
                  "Offline",
                  "Offline migration mode."
                ],
                [
                  "Online",
                  "Online migration mode."
                ]
              ],
              "old": [
                [
                  "Offline",
                  ""
                ],
                [
                  "Online",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrationOption",
            "Enum": {
              "new": [
                [
                  "Validate",
                  "Validate the migration without performing it."
                ],
                [
                  "Migrate",
                  "Perform the migration."
                ],
                [
                  "ValidateAndMigrate",
                  "Validate and perform the migration."
                ]
              ],
              "old": [
                [
                  "Validate",
                  ""
                ],
                [
                  "Migrate",
                  ""
                ],
                [
                  "ValidateAndMigrate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sourceType",
            "Enum": {
              "new": [
                [
                  "OnPremises",
                  "On-premises PostgreSQL server."
                ],
                [
                  "AWS",
                  "Amazon Web Services PostgreSQL server."
                ],
                [
                  "GCP",
                  "Google Cloud Platform PostgreSQL server."
                ],
                [
                  "AzureVM",
                  "Azure Virtual Machine PostgreSQL server."
                ],
                [
                  "PostgreSQLSingleServer",
                  "Azure Database for PostgreSQL single server."
                ],
                [
                  "AWS_RDS",
                  "Amazon RDS for PostgreSQL."
                ],
                [
                  "AWS_AURORA",
                  "Amazon Aurora for PostgreSQL."
                ],
                [
                  "AWS_EC2",
                  "Amazon EC2 for PostgreSQL."
                ],
                [
                  "GCP_CloudSQL",
                  "Google Cloud SQL for PostgreSQL."
                ],
                [
                  "GCP_AlloyDB",
                  "Google Cloud AlloyDB for PostgreSQL."
                ],
                [
                  "GCP_Compute",
                  "Google Compute Engine for PostgreSQL."
                ],
                [
                  "EDB",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "EDB_Oracle_Server",
                  "EnterpriseDB Oracle Server."
                ],
                [
                  "EDB_PostgreSQL",
                  "EnterpriseDB PostgreSQL server."
                ],
                [
                  "PostgreSQLFlexibleServer",
                  "Azure Database for PostgreSQL flexible server."
                ],
                [
                  "PostgreSQLCosmosDB",
                  ".NET Cosmos DB for PostgreSQL"
                ],
                [
                  "Huawei_RDS",
                  "Huawei RDS for PostgreSQL"
                ],
                [
                  "Huawei_Compute",
                  "Huawei Compute for PostgreSQL"
                ],
                [
                  "Heroku_PostgreSQL",
                  "Heroku PostgreSQL"
                ],
                [
                  "Crunchy_PostgreSQL",
                  "Crunchy PostgreSQL"
                ],
                [
                  "ApsaraDB_RDS",
                  "ApsaraDB RDS for PostgreSQL"
                ],
                [
                  "Digital_Ocean_Droplets",
                  "Digital Ocean Droplets for PostgreSQL"
                ],
                [
                  "Digital_Ocean_PostgreSQL",
                  "Digital Ocean PostgreSQL"
                ],
                [
                  "Supabase_PostgreSQL",
                  "Supabase PostgreSQL"
                ]
              ],
              "old": [
                [
                  "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",
                  ""
                ],
                [
                  "Supabase_PostgreSQL",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sslMode",
            "Enum": {
              "new": [
                [
                  "Prefer",
                  "Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL."
                ],
                [
                  "Require",
                  "Require SSL connection. If the server does not support SSL, the connection will fail."
                ],
                [
                  "VerifyCA",
                  "Require SSL connection and verify the server certificate against the CA certificate."
                ],
                [
                  "VerifyFull",
                  "Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate."
                ]
              ],
              "old": [
                [
                  "Prefer",
                  ""
                ],
                [
                  "Require",
                  ""
                ],
                [
                  "VerifyCA",
                  ""
                ],
                [
                  "VerifyFull",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
            "Enum": {
              "new": [
                [
                  "True",
                  "Logical replication will be set up on the source server."
                ],
                [
                  "False",
                  "Logical replication will not be set up on the source server."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "overwriteDbsInTarget",
            "Enum": {
              "new": [
                [
                  "True",
                  "Databases on the target server can be overwritten when already present."
                ],
                [
                  "False",
                  "Databases on the target server cannot be overwritten when already present."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "migrateRoles",
            "Enum": {
              "new": [
                [
                  "True",
                  "Roles and permissions will be migrated."
                ],
                [
                  "False",
                  "Roles and permissions will not be migrated."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "startDataMigration",
            "Enum": {
              "new": [
                [
                  "True",
                  "Data migration must start right away."
                ],
                [
                  "False",
                  "Data migration must not start right away."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "triggerCutover",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cutover must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cutover must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "cancel",
            "Enum": {
              "new": [
                [
                  "True",
                  "Cancel must be triggered for the entire migration."
                ],
                [
                  "False",
                  "Cancel must not be triggered for the entire migration."
                ]
              ],
              "old": [
                [
                  "True",
                  ""
                ],
                [
                  "False",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrations/{migrationName}
{
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 ,
migrationName:
{
Description: Name of migration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Migration properties. ,
Required: False ,
}
{
migrationId:
{
Description: Identifier of a migration. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of a migration. ,
Required: False ,
}
{
state:
{
Description: State of migration. ,
Enum:
{
InProgress: Migration is in progress. ,
WaitingForUserAction: Migration is waiting for user action. ,
Canceled: Migration has been canceled. ,
Failed: Migration has failed. ,
Succeeded: Migration has succeeded. ,
ValidationFailed: Validation for migration has failed. ,
CleaningUp: Migration is cleaning up resources. ,
}
,
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: Substate of migration. ,
Enum:
{
PerformingPreRequisiteSteps: Performing pre-requisite steps for migration. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: Waiting for logical replication setup request on source database. ,
WaitingForDBsToMigrateSpecification: Waiting for databases to migrate specification. ,
WaitingForTargetDBOverwriteConfirmation: Waiting for target database overwrite confirmation. ,
WaitingForDataMigrationScheduling: Waiting for data migration scheduling. ,
WaitingForDataMigrationWindow: Waiting for data migration window. ,
MigratingData: Migrating data. ,
WaitingForCutoverTrigger: Waiting for cutover trigger. ,
CompletingMigration: Completing migration. ,
Completed: Migration completed. ,
CancelingRequestedDBMigrations: Canceling requested database migrations. ,
ValidationInProgress: Validation in progress. ,
}
,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Start time (UTC) for validation. ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: End time (UTC) for validation. ,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations. ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of database. ,
Required: False ,
}
string ,
startedOn:
{
Description: Start time of a database level validation. ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End 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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: Identifier of the private endpoint migration instance. ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: Mode used to perform the migration: Online or Offline. ,
Enum:
{
Offline: Offline migration mode. ,
Online: Online migration mode. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: Supported option for a migration. ,
Enum:
{
Validate: Validate the migration without performing it. ,
Migrate: Perform the migration. ,
ValidateAndMigrate: Validate and perform the migration. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: On-premises PostgreSQL server. ,
AWS: Amazon Web Services PostgreSQL server. ,
GCP: Google Cloud Platform PostgreSQL server. ,
AzureVM: Azure Virtual Machine PostgreSQL server. ,
PostgreSQLSingleServer: Azure Database for PostgreSQL single server. ,
AWS_RDS: Amazon RDS for PostgreSQL. ,
AWS_AURORA: Amazon Aurora for PostgreSQL. ,
AWS_EC2: Amazon EC2 for PostgreSQL. ,
GCP_CloudSQL: Google Cloud SQL for PostgreSQL. ,
GCP_AlloyDB: Google Cloud AlloyDB for PostgreSQL. ,
GCP_Compute: Google Compute Engine for PostgreSQL. ,
EDB: EnterpriseDB PostgreSQL server. ,
EDB_Oracle_Server: EnterpriseDB Oracle Server. ,
EDB_PostgreSQL: EnterpriseDB PostgreSQL server. ,
PostgreSQLFlexibleServer: Azure Database for PostgreSQL flexible server. ,
PostgreSQLCosmosDB: .NET Cosmos DB for PostgreSQL ,
Huawei_RDS: Huawei RDS for PostgreSQL ,
Huawei_Compute: Huawei Compute for PostgreSQL ,
Heroku_PostgreSQL: Heroku PostgreSQL ,
Crunchy_PostgreSQL: Crunchy PostgreSQL ,
ApsaraDB_RDS: ApsaraDB RDS for PostgreSQL ,
Digital_Ocean_Droplets: Digital Ocean Droplets for PostgreSQL ,
Digital_Ocean_PostgreSQL: Digital Ocean PostgreSQL ,
Supabase_PostgreSQL: Supabase PostgreSQL ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. ,
Enum:
{
Prefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL. ,
Require: Require SSL connection. If the server does not support SSL, the connection will fail. ,
VerifyCA: Require SSL connection and verify the server certificate against the CA certificate. ,
VerifyFull: Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of source database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of target database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username. ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server. ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: Identifier of the target database server resource. ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server. ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters. ,
Required: False ,
}
{
adminCredentials:
{
Description: Credentials of administrator users for source and target servers. ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for the user of the source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for the user of the target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the name of the user for the source server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the name of the user for the target server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Names of databases to migrate. ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup logical replication on source server, if needed. ,
Enum:
{
True: Logical replication will be set up on the source server. ,
False: Logical replication will not be set up on the source server. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. ,
Enum:
{
True: Databases on the target server can be overwritten when already present. ,
False: Databases on the target server cannot be overwritten when already present. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: Indicates if roles and permissions must be migrated. ,
Enum:
{
True: Roles and permissions will be migrated. ,
False: Roles and permissions will not be migrated. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: Data migration must start right away. ,
False: Data migration must not start right away. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: Cutover must be triggered for the entire migration. ,
False: Cutover must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: Indicates if cancel must be triggered for the entire migration. ,
Enum:
{
True: Cancel must be triggered for the entire migration. ,
False: Cancel must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
Migrations_ListByTargetServer (updated)
Description :  Lists all migrations of a target flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migrations_ListByTargetServer",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "currentStatus": [
                  {
                    "#name": "state",
                    "Enum": {
                      "new": [
                        [
                          "InProgress",
                          "Migration is in progress."
                        ],
                        [
                          "WaitingForUserAction",
                          "Migration is waiting for user action."
                        ],
                        [
                          "Canceled",
                          "Migration has been canceled."
                        ],
                        [
                          "Failed",
                          "Migration has failed."
                        ],
                        [
                          "Succeeded",
                          "Migration has succeeded."
                        ],
                        [
                          "ValidationFailed",
                          "Validation for migration has failed."
                        ],
                        [
                          "CleaningUp",
                          "Migration is cleaning up resources."
                        ]
                      ],
                      "old": [
                        [
                          "InProgress",
                          ""
                        ],
                        [
                          "WaitingForUserAction",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "ValidationFailed",
                          ""
                        ],
                        [
                          "CleaningUp",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "currentSubStateDetails": [
                      {
                        "#name": "currentSubState",
                        "Enum": {
                          "new": [
                            [
                              "PerformingPreRequisiteSteps",
                              "Performing pre-requisite steps for migration."
                            ],
                            [
                              "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                              "Waiting for logical replication setup request on source database."
                            ],
                            [
                              "WaitingForDBsToMigrateSpecification",
                              "Waiting for databases to migrate specification."
                            ],
                            [
                              "WaitingForTargetDBOverwriteConfirmation",
                              "Waiting for target database overwrite confirmation."
                            ],
                            [
                              "WaitingForDataMigrationScheduling",
                              "Waiting for data migration scheduling."
                            ],
                            [
                              "WaitingForDataMigrationWindow",
                              "Waiting for data migration window."
                            ],
                            [
                              "MigratingData",
                              "Migrating data."
                            ],
                            [
                              "WaitingForCutoverTrigger",
                              "Waiting for cutover trigger."
                            ],
                            [
                              "CompletingMigration",
                              "Completing migration."
                            ],
                            [
                              "Completed",
                              "Migration completed."
                            ],
                            [
                              "CancelingRequestedDBMigrations",
                              "Canceling requested database migrations."
                            ],
                            [
                              "ValidationInProgress",
                              "Validation in progress."
                            ]
                          ],
                          "old": [
                            [
                              "PerformingPreRequisiteSteps",
                              ""
                            ],
                            [
                              "WaitingForLogicalReplicationSetupRequestOnSourceDB",
                              ""
                            ],
                            [
                              "WaitingForDBsToMigrateSpecification",
                              ""
                            ],
                            [
                              "WaitingForTargetDBOverwriteConfirmation",
                              ""
                            ],
                            [
                              "WaitingForDataMigrationScheduling",
                              ""
                            ],
                            [
                              "WaitingForDataMigrationWindow",
                              ""
                            ],
                            [
                              "MigratingData",
                              ""
                            ],
                            [
                              "WaitingForCutoverTrigger",
                              ""
                            ],
                            [
                              "CompletingMigration",
                              ""
                            ],
                            [
                              "Completed",
                              ""
                            ],
                            [
                              "CancelingRequestedDBMigrations",
                              ""
                            ],
                            [
                              "ValidationInProgress",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "validationDetails": [
                          {
                            "#name": "status",
                            "Enum": {
                              "new": [
                                [
                                  "Failed",
                                  "Validation has failed."
                                ],
                                [
                                  "Succeeded",
                                  "Validation has succeeded."
                                ],
                                [
                                  "Warning",
                                  "Validation has succeeded with warnings."
                                ]
                              ],
                              "old": [
                                [
                                  "Failed",
                                  ""
                                ],
                                [
                                  "Succeeded",
                                  ""
                                ],
                                [
                                  "Warning",
                                  ""
                                ]
                              ]
                            }
                          },
                          {
                            "serverLevelValidationDetails": {
                              "$properties": [
                                {
                                  "#name": "state",
                                  "Enum": {
                                    "new": [
                                      [
                                        "Failed",
                                        "Validation has failed."
                                      ],
                                      [
                                        "Succeeded",
                                        "Validation has succeeded."
                                      ],
                                      [
                                        "Warning",
                                        "Validation has succeeded with warnings."
                                      ]
                                    ],
                                    "old": [
                                      [
                                        "Failed",
                                        ""
                                      ],
                                      [
                                        "Succeeded",
                                        ""
                                      ],
                                      [
                                        "Warning",
                                        ""
                                      ]
                                    ]
                                  }
                                },
                                {
                                  "messages": {
                                    "$properties": [
                                      {
                                        "#name": "state",
                                        "Enum": {
                                          "new": [
                                            [
                                              "Failed",
                                              "Validation has failed."
                                            ],
                                            [
                                              "Succeeded",
                                              "Validation has succeeded."
                                            ],
                                            [
                                              "Warning",
                                              "Validation has succeeded with warnings."
                                            ]
                                          ],
                                          "old": [
                                            [
                                              "Failed",
                                              ""
                                            ],
                                            [
                                              "Succeeded",
                                              ""
                                            ],
                                            [
                                              "Warning",
                                              ""
                                            ]
                                          ]
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "dbLevelValidationDetails": {
                              "$properties": {
                                "summary": {
                                  "$properties": [
                                    {
                                      "#name": "state",
                                      "Enum": {
                                        "new": [
                                          [
                                            "Failed",
                                            "Validation has failed."
                                          ],
                                          [
                                            "Succeeded",
                                            "Validation has succeeded."
                                          ],
                                          [
                                            "Warning",
                                            "Validation has succeeded with warnings."
                                          ]
                                        ],
                                        "old": [
                                          [
                                            "Failed",
                                            ""
                                          ],
                                          [
                                            "Succeeded",
                                            ""
                                          ],
                                          [
                                            "Warning",
                                            ""
                                          ]
                                        ]
                                      }
                                    },
                                    {
                                      "messages": {
                                        "$properties": [
                                          {
                                            "#name": "state",
                                            "Enum": {
                                              "new": [
                                                [
                                                  "Failed",
                                                  "Validation has failed."
                                                ],
                                                [
                                                  "Succeeded",
                                                  "Validation has succeeded."
                                                ],
                                                [
                                                  "Warning",
                                                  "Validation has succeeded with warnings."
                                                ]
                                              ],
                                              "old": [
                                                [
                                                  "Failed",
                                                  ""
                                                ],
                                                [
                                                  "Succeeded",
                                                  ""
                                                ],
                                                [
                                                  "Warning",
                                                  ""
                                                ]
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "migrationMode",
                "Enum": {
                  "new": [
                    [
                      "Offline",
                      "Offline migration mode."
                    ],
                    [
                      "Online",
                      "Online migration mode."
                    ]
                  ],
                  "old": [
                    [
                      "Offline",
                      ""
                    ],
                    [
                      "Online",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "migrationOption",
                "Enum": {
                  "new": [
                    [
                      "Validate",
                      "Validate the migration without performing it."
                    ],
                    [
                      "Migrate",
                      "Perform the migration."
                    ],
                    [
                      "ValidateAndMigrate",
                      "Validate and perform the migration."
                    ]
                  ],
                  "old": [
                    [
                      "Validate",
                      ""
                    ],
                    [
                      "Migrate",
                      ""
                    ],
                    [
                      "ValidateAndMigrate",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "sourceType",
                "Enum": {
                  "new": [
                    [
                      "OnPremises",
                      "On-premises PostgreSQL server."
                    ],
                    [
                      "AWS",
                      "Amazon Web Services PostgreSQL server."
                    ],
                    [
                      "GCP",
                      "Google Cloud Platform PostgreSQL server."
                    ],
                    [
                      "AzureVM",
                      "Azure Virtual Machine PostgreSQL server."
                    ],
                    [
                      "PostgreSQLSingleServer",
                      "Azure Database for PostgreSQL single server."
                    ],
                    [
                      "AWS_RDS",
                      "Amazon RDS for PostgreSQL."
                    ],
                    [
                      "AWS_AURORA",
                      "Amazon Aurora for PostgreSQL."
                    ],
                    [
                      "AWS_EC2",
                      "Amazon EC2 for PostgreSQL."
                    ],
                    [
                      "GCP_CloudSQL",
                      "Google Cloud SQL for PostgreSQL."
                    ],
                    [
                      "GCP_AlloyDB",
                      "Google Cloud AlloyDB for PostgreSQL."
                    ],
                    [
                      "GCP_Compute",
                      "Google Compute Engine for PostgreSQL."
                    ],
                    [
                      "EDB",
                      "EnterpriseDB PostgreSQL server."
                    ],
                    [
                      "EDB_Oracle_Server",
                      "EnterpriseDB Oracle Server."
                    ],
                    [
                      "EDB_PostgreSQL",
                      "EnterpriseDB PostgreSQL server."
                    ],
                    [
                      "PostgreSQLFlexibleServer",
                      "Azure Database for PostgreSQL flexible server."
                    ],
                    [
                      "PostgreSQLCosmosDB",
                      ".NET Cosmos DB for PostgreSQL"
                    ],
                    [
                      "Huawei_RDS",
                      "Huawei RDS for PostgreSQL"
                    ],
                    [
                      "Huawei_Compute",
                      "Huawei Compute for PostgreSQL"
                    ],
                    [
                      "Heroku_PostgreSQL",
                      "Heroku PostgreSQL"
                    ],
                    [
                      "Crunchy_PostgreSQL",
                      "Crunchy PostgreSQL"
                    ],
                    [
                      "ApsaraDB_RDS",
                      "ApsaraDB RDS for PostgreSQL"
                    ],
                    [
                      "Digital_Ocean_Droplets",
                      "Digital Ocean Droplets for PostgreSQL"
                    ],
                    [
                      "Digital_Ocean_PostgreSQL",
                      "Digital Ocean PostgreSQL"
                    ],
                    [
                      "Supabase_PostgreSQL",
                      "Supabase PostgreSQL"
                    ]
                  ],
                  "old": [
                    [
                      "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",
                      ""
                    ],
                    [
                      "Supabase_PostgreSQL",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "sslMode",
                "Enum": {
                  "new": [
                    [
                      "Prefer",
                      "Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL."
                    ],
                    [
                      "Require",
                      "Require SSL connection. If the server does not support SSL, the connection will fail."
                    ],
                    [
                      "VerifyCA",
                      "Require SSL connection and verify the server certificate against the CA certificate."
                    ],
                    [
                      "VerifyFull",
                      "Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate."
                    ]
                  ],
                  "old": [
                    [
                      "Prefer",
                      ""
                    ],
                    [
                      "Require",
                      ""
                    ],
                    [
                      "VerifyCA",
                      ""
                    ],
                    [
                      "VerifyFull",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
                "Enum": {
                  "new": [
                    [
                      "True",
                      "Logical replication will be set up on the source server."
                    ],
                    [
                      "False",
                      "Logical replication will not be set up on the source server."
                    ]
                  ],
                  "old": [
                    [
                      "True",
                      ""
                    ],
                    [
                      "False",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "overwriteDbsInTarget",
                "Enum": {
                  "new": [
                    [
                      "True",
                      "Databases on the target server can be overwritten when already present."
                    ],
                    [
                      "False",
                      "Databases on the target server cannot be overwritten when already present."
                    ]
                  ],
                  "old": [
                    [
                      "True",
                      ""
                    ],
                    [
                      "False",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "migrateRoles",
                "Enum": {
                  "new": [
                    [
                      "True",
                      "Roles and permissions will be migrated."
                    ],
                    [
                      "False",
                      "Roles and permissions will not be migrated."
                    ]
                  ],
                  "old": [
                    [
                      "True",
                      ""
                    ],
                    [
                      "False",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "startDataMigration",
                "Enum": {
                  "new": [
                    [
                      "True",
                      "Data migration must start right away."
                    ],
                    [
                      "False",
                      "Data migration must not start right away."
                    ]
                  ],
                  "old": [
                    [
                      "True",
                      ""
                    ],
                    [
                      "False",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "triggerCutover",
                "Enum": {
                  "new": [
                    [
                      "True",
                      "Cutover must be triggered for the entire migration."
                    ],
                    [
                      "False",
                      "Cutover must not be triggered for the entire migration."
                    ]
                  ],
                  "old": [
                    [
                      "True",
                      ""
                    ],
                    [
                      "False",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "cancel",
                "Enum": {
                  "new": [
                    [
                      "True",
                      "Cancel must be triggered for the entire migration."
                    ],
                    [
                      "False",
                      "Cancel must not be triggered for the entire migration."
                    ]
                  ],
                  "old": [
                    [
                      "True",
                      ""
                    ],
                    [
                      "False",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrations
{
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 ,
migrationListFilter:
{
Description: Migration list filter. Indicates if the request should retrieve only active migrations or all migrations. Defaults to Active. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of migrations. ,
Required: False ,
}
[
{
properties:
{
Description: Migration properties. ,
Required: False ,
}
{
migrationId:
{
Description: Identifier of a migration. ,
Required: False ,
}
string ,
currentStatus:
{
Description: Current status of a migration. ,
Required: False ,
}
{
state:
{
Description: State of migration. ,
Enum:
{
InProgress: Migration is in progress. ,
WaitingForUserAction: Migration is waiting for user action. ,
Canceled: Migration has been canceled. ,
Failed: Migration has failed. ,
Succeeded: Migration has succeeded. ,
ValidationFailed: Validation for migration has failed. ,
CleaningUp: Migration is cleaning up resources. ,
}
,
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: Substate of migration. ,
Enum:
{
PerformingPreRequisiteSteps: Performing pre-requisite steps for migration. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: Waiting for logical replication setup request on source database. ,
WaitingForDBsToMigrateSpecification: Waiting for databases to migrate specification. ,
WaitingForTargetDBOverwriteConfirmation: Waiting for target database overwrite confirmation. ,
WaitingForDataMigrationScheduling: Waiting for data migration scheduling. ,
WaitingForDataMigrationWindow: Waiting for data migration window. ,
MigratingData: Migrating data. ,
WaitingForCutoverTrigger: Waiting for cutover trigger. ,
CompletingMigration: Completing migration. ,
Completed: Migration completed. ,
CancelingRequestedDBMigrations: Canceling requested database migrations. ,
ValidationInProgress: Validation in progress. ,
}
,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: Start time (UTC) for validation. ,
Format: date-time ,
Required: False ,
}
string ,
validationEndTimeInUtc:
{
Description: End time (UTC) for validation. ,
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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations. ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of database. ,
Required: False ,
}
string ,
startedOn:
{
Description: Start time of a database level validation. ,
Format: date-time ,
Required: False ,
}
string ,
endedOn:
{
Description: End 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: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: Validation has failed. ,
Succeeded: Validation has succeeded. ,
Warning: Validation has succeeded with warnings. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: Identifier of the private endpoint migration instance. ,
Format: arm-id ,
Required: False ,
}
string ,
migrationMode:
{
Description: Mode used to perform the migration: Online or Offline. ,
Enum:
{
Offline: Offline migration mode. ,
Online: Online migration mode. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: Supported option for a migration. ,
Enum:
{
Validate: Validate the migration without performing it. ,
Migrate: Perform the migration. ,
ValidateAndMigrate: Validate and perform the migration. ,
}
,
Required: False ,
}
enum ,
sourceType:
{
Description: Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL ,
Enum:
{
OnPremises: On-premises PostgreSQL server. ,
AWS: Amazon Web Services PostgreSQL server. ,
GCP: Google Cloud Platform PostgreSQL server. ,
AzureVM: Azure Virtual Machine PostgreSQL server. ,
PostgreSQLSingleServer: Azure Database for PostgreSQL single server. ,
AWS_RDS: Amazon RDS for PostgreSQL. ,
AWS_AURORA: Amazon Aurora for PostgreSQL. ,
AWS_EC2: Amazon EC2 for PostgreSQL. ,
GCP_CloudSQL: Google Cloud SQL for PostgreSQL. ,
GCP_AlloyDB: Google Cloud AlloyDB for PostgreSQL. ,
GCP_Compute: Google Compute Engine for PostgreSQL. ,
EDB: EnterpriseDB PostgreSQL server. ,
EDB_Oracle_Server: EnterpriseDB Oracle Server. ,
EDB_PostgreSQL: EnterpriseDB PostgreSQL server. ,
PostgreSQLFlexibleServer: Azure Database for PostgreSQL flexible server. ,
PostgreSQLCosmosDB: .NET Cosmos DB for PostgreSQL ,
Huawei_RDS: Huawei RDS for PostgreSQL ,
Huawei_Compute: Huawei Compute for PostgreSQL ,
Heroku_PostgreSQL: Heroku PostgreSQL ,
Crunchy_PostgreSQL: Crunchy PostgreSQL ,
ApsaraDB_RDS: ApsaraDB RDS for PostgreSQL ,
Digital_Ocean_Droplets: Digital Ocean Droplets for PostgreSQL ,
Digital_Ocean_PostgreSQL: Digital Ocean PostgreSQL ,
Supabase_PostgreSQL: Supabase PostgreSQL ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. ,
Enum:
{
Prefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL. ,
Require: Require SSL connection. If the server does not support SSL, the connection will fail. ,
VerifyCA: Require SSL connection and verify the server certificate against the CA certificate. ,
VerifyFull: Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate. ,
}
,
Required: False ,
}
enum ,
sourceDbServerMetadata:
{
Description: Metadata of source database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
targetDbServerMetadata:
{
Description: Metadata of target database server. ,
Required: False ,
}
{
location:
{
Description: Location of database server. ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Required: False ,
}
string ,
storageMb:
{
Description: Storage size (in MB) for database server. ,
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
{
name:
{
Description: Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sourceDbServerResourceId:
{
Description: Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username. ,
Required: False ,
}
string ,
sourceDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server. ,
Required: False ,
}
string ,
targetDbServerResourceId:
{
Description: Identifier of the target database server resource. ,
Required: False ,
}
string ,
targetDbServerFullyQualifiedDomainName:
{
Description: Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server. ,
Required: False ,
}
string ,
secretParameters:
{
Description: Migration secret parameters. ,
Required: False ,
}
{
adminCredentials:
{
Description: Credentials of administrator users for source and target servers. ,
Required: True ,
}
{
sourceServerPassword:
{
Description: Password for the user of the source server. ,
Required: True ,
}
string ,
targetServerPassword:
{
Description: Password for the user of the target server. ,
Required: True ,
}
string ,
}
,
sourceServerUsername:
{
Description: Gets or sets the name of the user for the source server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
targetServerUsername:
{
Description: Gets or sets the name of the user for the target server. This user doesn't need to be an administrator. ,
Required: False ,
}
string ,
}
,
dbsToMigrate:
{
Description: Names of databases to migrate. ,
Required: False ,
}
[
string ,
]
,
setupLogicalReplicationOnSourceDbIfNeeded:
{
Description: Indicates whether to setup logical replication on source server, if needed. ,
Enum:
{
True: Logical replication will be set up on the source server. ,
False: Logical replication will not be set up on the source server. ,
}
,
Required: False ,
}
enum ,
overwriteDbsInTarget:
{
Description: Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. ,
Enum:
{
True: Databases on the target server can be overwritten when already present. ,
False: Databases on the target server cannot be overwritten when already present. ,
}
,
Required: False ,
}
enum ,
migrationWindowStartTimeInUtc:
{
Description: Start time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrationWindowEndTimeInUtc:
{
Description: End time (UTC) for migration window. ,
Format: date-time ,
Required: False ,
}
string ,
migrateRoles:
{
Description: Indicates if roles and permissions must be migrated. ,
Enum:
{
True: Roles and permissions will be migrated. ,
False: Roles and permissions will not be migrated. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: Data migration must start right away. ,
False: Data migration must not start right away. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: Cutover must be triggered for the entire migration. ,
False: Cutover must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToTriggerCutoverOn:
{
Description: When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
cancel:
{
Description: Indicates if cancel must be triggered for the entire migration. ,
Enum:
{
True: Cancel must be triggered for the entire migration. ,
False: Cancel must not be triggered for the entire migration. ,
}
,
Required: False ,
}
enum ,
dbsToCancelMigrationOn:
{
Description: When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link used to get the next page 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 ,
}
,
]
,
}
,
}
Migrations_CheckNameAvailability (updated)
Description :  Checks if a proposed migration name is valid and available.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migrations_CheckNameAvailability",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "reason",
          "Enum": {
            "new": [
              [
                "Invalid",
                "Migration name is invalid."
              ],
              [
                "AlreadyExists",
                "Migration name already exists."
              ]
            ],
            "old": [
              [
                "Invalid",
                ""
              ],
              [
                "AlreadyExists",
                ""
              ]
            ]
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "reason",
          "Enum": {
            "new": [
              [
                "Invalid",
                "Migration name is invalid."
              ],
              [
                "AlreadyExists",
                "Migration name already exists."
              ]
            ],
            "old": [
              [
                "Invalid",
                ""
              ],
              [
                "AlreadyExists",
                ""
              ]
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/checkMigrationNameAvailability
{
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: Parameters required to check if a migration name is valid and available. ,
Required: True ,
}
{
name:
{
Description: Name of the migration to check for validity and availability. ,
Required: True ,
}
string ,
type:
{
Description: Type of resource. ,
Required: True ,
}
string ,
nameAvailable:
{
Description: Indicates if the migration name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: Migration name availability reason. ,
Enum:
{
Invalid: Migration name is invalid. ,
AlreadyExists: Migration name already exists. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Migration name availability message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the migration to check for validity and availability. ,
Required: True ,
}
string ,
type:
{
Description: Type of resource. ,
Required: True ,
}
string ,
nameAvailable:
{
Description: Indicates if the migration name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: Migration name availability reason. ,
Enum:
{
Invalid: Migration name is invalid. ,
AlreadyExists: Migration name already exists. ,
}
,
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 (updated)
Description :  Lists all available REST API operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "origin",
              "Enum": {
                "new": [
                  [
                    "NotSpecified",
                    "The origin is not specified."
                  ],
                  [
                    "user",
                    "The operation is initiated by a user."
                  ],
                  [
                    "system",
                    "The operation is initiated by the system."
                  ]
                ],
                "old": [
                  [
                    "NotSpecified",
                    ""
                  ],
                  [
                    "user",
                    ""
                  ],
                  [
                    "system",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ 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: Name of the operation being performed on this particular object. ,
Required: False ,
}
string ,
display:
{
Description: Localized display information for this particular operation or action. ,
Required: False ,
}
{
provider:
{
Description: Name of the resource provider. ,
Required: False ,
}
string ,
resource:
{
Description: Type of resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Indicates if the operation is a data action. ,
Required: False ,
}
boolean ,
origin:
{
Description: Intended executor of the operation. ,
Enum:
{
NotSpecified: The origin is not specified. ,
user: The operation is initiated by a user. ,
system: The operation is initiated by the system. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link used to get the 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 ,
}
,
]
,
}
,
}
Servers_CreateOrUpdate (updated)
Description :  Creates a new server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "sku": [
          {
            "#name": "tier",
            "Enum": {
              "new": [
                [
                  "Burstable",
                  "Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements."
                ],
                [
                  "GeneralPurpose",
                  "Balanced compute and memory for most workloads, offering scalable performance and I/O throughput."
                ],
                [
                  "MemoryOptimized",
                  "High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency."
                ]
              ],
              "old": [
                [
                  "Burstable",
                  ""
                ],
                [
                  "GeneralPurpose",
                  ""
                ],
                [
                  "MemoryOptimized",
                  ""
                ]
              ]
            }
          }
        ],
        "identity": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "None",
                  "No managed identity is assigned to the server."
                ],
                [
                  "UserAssigned",
                  "One or more managed identities provided by the user are assigned to the server."
                ],
                [
                  "SystemAssigned",
                  "Azure automatically creates and manages the identity associated to the lifecycle of the server."
                ],
                [
                  "SystemAssigned,UserAssigned",
                  "Both system-assigned and user-assigned identities are assigned to the server."
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ]
            }
          }
        ],
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "17",
                  "PostgreSQL 17."
                ],
                [
                  "16",
                  "PostgreSQL 16."
                ],
                [
                  "15",
                  "PostgreSQL 15."
                ],
                [
                  "14",
                  "PostgreSQL 14."
                ],
                [
                  "13",
                  "PostgreSQL 13."
                ],
                [
                  "12",
                  "PostgreSQL 12."
                ],
                [
                  "11",
                  "PostgreSQL 11."
                ]
              ],
              "old": [
                [
                  "17",
                  ""
                ],
                [
                  "16",
                  ""
                ],
                [
                  "15",
                  ""
                ],
                [
                  "14",
                  ""
                ],
                [
                  "13",
                  ""
                ],
                [
                  "12",
                  ""
                ],
                [
                  "11",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "state",
            "Enum": {
              "new": [
                [
                  "Ready",
                  "Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level."
                ],
                [
                  "Dropping",
                  "Server is being deleted."
                ],
                [
                  "Disabled",
                  "Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription."
                ],
                [
                  "Starting",
                  "PostgreSQL database engine is being restarted."
                ],
                [
                  "Stopping",
                  "Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated."
                ],
                [
                  "Stopped",
                  "Compute resources associated with the server are being stopped and deallocated."
                ],
                [
                  "Updating",
                  "Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine."
                ],
                [
                  "Restarting",
                  "PostgreSQL database engine is being restarted."
                ],
                [
                  "Inaccessible",
                  "Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state."
                ],
                [
                  "Provisioning",
                  "Server is in the process of being created."
                ]
              ],
              "old": [
                [
                  "Ready",
                  ""
                ],
                [
                  "Dropping",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ],
                [
                  "Starting",
                  ""
                ],
                [
                  "Stopping",
                  ""
                ],
                [
                  "Stopped",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Restarting",
                  ""
                ],
                [
                  "Inaccessible",
                  ""
                ],
                [
                  "Provisioning",
                  ""
                ]
              ]
            }
          },
          {
            "storage": [
              {
                "#name": "autoGrow",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size."
                    ],
                    [
                      "Disabled",
                      "Server should not automatically grow storage size when available space is nearing zero."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "tier",
                "Enum": {
                  "new": [
                    [
                      "P1",
                      "Entry-level SSD for minimal IOPS, ideal for light development or testing workloads."
                    ],
                    [
                      "P2",
                      "Slightly higher IOPS for small-scale applications needing consistent low latency."
                    ],
                    [
                      "P3",
                      "Balanced performance for basic production workloads with moderate throughput."
                    ],
                    [
                      "P4",
                      "Enhanced IOPS for growing apps with predictable performance needs."
                    ],
                    [
                      "P6",
                      "Mid-tier SSD for steady workloads requiring reliable throughput and latency."
                    ],
                    [
                      "P10",
                      "Popular choice for general-purpose production workloads with scalable performance."
                    ],
                    [
                      "P15",
                      "High IOPS tier for demanding apps with frequent read/write operations."
                    ],
                    [
                      "P20",
                      "Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads."
                    ],
                    [
                      "P30",
                      "Balanced tier for moderate throughput and latency-sensitive applications."
                    ],
                    [
                      "P40",
                      "Enhanced performance for growing production workloads with consistent IOPS demands."
                    ],
                    [
                      "P50",
                      "Optimized for enterprise-grade applications needing sustained high throughput."
                    ],
                    [
                      "P60",
                      "High-capacity tier for large databases and analytics workloads with elevated IOPS."
                    ],
                    [
                      "P70",
                      "Designed for mission-critical systems requiring ultra-low latency and high concurrency."
                    ],
                    [
                      "P80",
                      "Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads."
                    ]
                  ],
                  "old": [
                    [
                      "P1",
                      ""
                    ],
                    [
                      "P2",
                      ""
                    ],
                    [
                      "P3",
                      ""
                    ],
                    [
                      "P4",
                      ""
                    ],
                    [
                      "P6",
                      ""
                    ],
                    [
                      "P10",
                      ""
                    ],
                    [
                      "P15",
                      ""
                    ],
                    [
                      "P20",
                      ""
                    ],
                    [
                      "P30",
                      ""
                    ],
                    [
                      "P40",
                      ""
                    ],
                    [
                      "P50",
                      ""
                    ],
                    [
                      "P60",
                      ""
                    ],
                    [
                      "P70",
                      ""
                    ],
                    [
                      "P80",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "Premium_LRS",
                      "Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads."
                    ],
                    [
                      "PremiumV2_LRS",
                      "Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads."
                    ],
                    [
                      "UltraSSD_LRS",
                      "High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications."
                    ]
                  ],
                  "old": [
                    [
                      "Premium_LRS",
                      ""
                    ],
                    [
                      "PremiumV2_LRS",
                      ""
                    ],
                    [
                      "UltraSSD_LRS",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "authConfig": [
              {
                "#name": "activeDirectoryAuth",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server supports Microsoft Entra authentication."
                    ],
                    [
                      "Disabled",
                      "Server doesn't support Microsoft Entra authentication."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "passwordAuth",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server supports password based authentication."
                    ],
                    [
                      "Disabled",
                      "Server doesn't support password based authentication."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "dataEncryption": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "SystemManaged",
                      "Encryption managed by Azure using platform managed keys for simplicity and compliance."
                    ],
                    [
                      "AzureKeyVault",
                      "Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security."
                    ]
                  ],
                  "old": [
                    [
                      "SystemManaged",
                      ""
                    ],
                    [
                      "AzureKeyVault",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "primaryEncryptionKeyStatus",
                "Enum": {
                  "new": [
                    [
                      "Valid",
                      "Key is valid and can be used for encryption."
                    ],
                    [
                      "Invalid",
                      "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                    ]
                  ],
                  "old": [
                    [
                      "Valid",
                      ""
                    ],
                    [
                      "Invalid",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "geoBackupEncryptionKeyStatus",
                "Enum": {
                  "new": [
                    [
                      "Valid",
                      "Key is valid and can be used for encryption."
                    ],
                    [
                      "Invalid",
                      "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                    ]
                  ],
                  "old": [
                    [
                      "Valid",
                      ""
                    ],
                    [
                      "Invalid",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "backup": [
              {
                "#name": "geoRedundantBackup",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server is configured to create geographically redundant backups."
                    ],
                    [
                      "Disabled",
                      "Server is not configured to create geographically redundant backups."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "network": [
              {
                "#name": "publicNetworkAccess",
                "Description": {
                  "new": "Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed.",
                  "old": "Indicates if public network access is enabled or not."
                },
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server."
                    ],
                    [
                      "Disabled",
                      "Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "highAvailability": [
              {
                "#name": "mode",
                "Enum": {
                  "new": [
                    [
                      "Disabled",
                      "High availability is disabled for the server."
                    ],
                    [
                      "ZoneRedundant",
                      "High availability is enabled for the server, with standby server in a different availability zone than that of the primary."
                    ],
                    [
                      "SameZone",
                      "High availability is enabled for the server, with standby server in the same availability zone as the primary."
                    ]
                  ],
                  "old": [
                    [
                      "Disabled",
                      ""
                    ],
                    [
                      "ZoneRedundant",
                      ""
                    ],
                    [
                      "SameZone",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "NotEnabled",
                      "High availability is not enabled for the server."
                    ],
                    [
                      "CreatingStandby",
                      "Standby server is being created."
                    ],
                    [
                      "ReplicatingData",
                      "Data is being replicated to the standby server."
                    ],
                    [
                      "FailingOver",
                      "Failover operation to the standby server is in progress."
                    ],
                    [
                      "Healthy",
                      "Standby server is healthy and ready to take over in case of a failover."
                    ],
                    [
                      "RemovingStandby",
                      "Standby server is being removed."
                    ]
                  ],
                  "old": [
                    [
                      "NotEnabled",
                      ""
                    ],
                    [
                      "CreatingStandby",
                      ""
                    ],
                    [
                      "ReplicatingData",
                      ""
                    ],
                    [
                      "FailingOver",
                      ""
                    ],
                    [
                      "Healthy",
                      ""
                    ],
                    [
                      "RemovingStandby",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "replicationRole",
            "Enum": {
              "new": [
                [
                  "None",
                  "No replication role assigned; the server operates independently."
                ],
                [
                  "Primary",
                  "Acts as the source server for replication to one or more replicas."
                ],
                [
                  "AsyncReplica",
                  "Receives data asynchronously from a primary server within the same region."
                ],
                [
                  "GeoAsyncReplica",
                  "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Primary",
                  ""
                ],
                [
                  "AsyncReplica",
                  ""
                ],
                [
                  "GeoAsyncReplica",
                  ""
                ]
              ]
            }
          },
          {
            "replica": [
              {
                "#name": "role",
                "Enum": {
                  "new": [
                    [
                      "None",
                      "No replication role assigned; the server operates independently."
                    ],
                    [
                      "Primary",
                      "Acts as the source server for replication to one or more replicas."
                    ],
                    [
                      "AsyncReplica",
                      "Receives data asynchronously from a primary server within the same region."
                    ],
                    [
                      "GeoAsyncReplica",
                      "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "Primary",
                      ""
                    ],
                    [
                      "AsyncReplica",
                      ""
                    ],
                    [
                      "GeoAsyncReplica",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "replicationState",
                "Enum": {
                  "new": [
                    [
                      "Active",
                      "Read replica is fully synchronized and actively replicating data from the primary server."
                    ],
                    [
                      "Catchup",
                      "Read replica is behind the primary server and is currently catching up with pending changes."
                    ],
                    [
                      "Provisioning",
                      "Read replica is being created and is in process of getting initialized."
                    ],
                    [
                      "Updating",
                      "Read replica is undergoing some changes it can be changing compute size of promoting it to primary server."
                    ],
                    [
                      "Broken",
                      "Replication has failed or been interrupted."
                    ],
                    [
                      "Reconfiguring",
                      "Read replica is being reconfigured, possibly due to changes in source or settings."
                    ]
                  ],
                  "old": [
                    [
                      "Active",
                      "The read replica server is fully synchronized and actively replicating data from the primary server."
                    ],
                    [
                      "Catchup",
                      "The read replica server is behind the primary server and is currently catching up with pending changes."
                    ],
                    [
                      "Provisioning",
                      "The read replica server is being created and is in process of getting initialized."
                    ],
                    [
                      "Updating",
                      "The read replica server is undergoing some changes it can be changing compute size of promoting it to primary server."
                    ],
                    [
                      "Broken",
                      "Replication has failed or been interrupted."
                    ],
                    [
                      "Reconfiguring",
                      "The read replica server is being reconfigured, possibly due to changes in source or settings."
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "createMode",
            "Enum": {
              "new": [
                [
                  "Default",
                  "If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'."
                ],
                [
                  "Create",
                  "Operation creates a new server."
                ],
                [
                  "Update",
                  "Operation updates an existing server."
                ],
                [
                  "PointInTimeRestore",
                  "Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time."
                ],
                [
                  "GeoRestore",
                  "Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled."
                ],
                [
                  "Replica",
                  "Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary."
                ],
                [
                  "ReviveDropped",
                  "Operation creates a new server, initialized with the backup of a server that was recently deleted."
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Create",
                  ""
                ],
                [
                  "Update",
                  ""
                ],
                [
                  "PointInTimeRestore",
                  ""
                ],
                [
                  "GeoRestore",
                  ""
                ],
                [
                  "Replica",
                  ""
                ],
                [
                  "ReviveDropped",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Parameters required to create a new server or to update an existing server. ,
Required: True ,
}
{
sku:
{
Description: Compute tier and size of a server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements. ,
GeneralPurpose: Balanced compute and memory for most workloads, offering scalable performance and I/O throughput. ,
MemoryOptimized: High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: Map of user assigned managed identities. ,
Required: False ,
}
object ,
principalId:
{
Description: Identifier of the object of the service principal associated to the user assigned managed identity. ,
Required: False ,
}
string ,
type:
{
Description: Types of identities associated with a server. ,
Enum:
{
None: No managed identity is assigned to the server. ,
UserAssigned: One or more managed identities provided by the user are assigned to the server. ,
SystemAssigned: Azure automatically creates and manages the identity associated to the lifecycle of the server. ,
SystemAssigned,UserAssigned: Both system-assigned and user-assigned identities are assigned to the server. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a server. ,
Required: False ,
}
{
administratorLogin:
{
Description: Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Enum:
{
17: PostgreSQL 17. ,
16: PostgreSQL 16. ,
15: PostgreSQL 15. ,
14: PostgreSQL 14. ,
13: PostgreSQL 13. ,
12: PostgreSQL 12. ,
11: PostgreSQL 11. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a server. ,
Enum:
{
Ready: Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level. ,
Dropping: Server is being deleted. ,
Disabled: Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription. ,
Starting: PostgreSQL database engine is being restarted. ,
Stopping: Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated. ,
Stopped: Compute resources associated with the server are being stopped and deallocated. ,
Updating: Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine. ,
Restarting: PostgreSQL database engine is being restarted. ,
Inaccessible: Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state. ,
Provisioning: Server is in the process of being created. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size. ,
Disabled: Server should not automatically grow storage size when available space is nearing zero. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a server. ,
Enum:
{
P1: Entry-level SSD for minimal IOPS, ideal for light development or testing workloads. ,
P2: Slightly higher IOPS for small-scale applications needing consistent low latency. ,
P3: Balanced performance for basic production workloads with moderate throughput. ,
P4: Enhanced IOPS for growing apps with predictable performance needs. ,
P6: Mid-tier SSD for steady workloads requiring reliable throughput and latency. ,
P10: Popular choice for general-purpose production workloads with scalable performance. ,
P15: High IOPS tier for demanding apps with frequent read/write operations. ,
P20: Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads. ,
P30: Balanced tier for moderate throughput and latency-sensitive applications. ,
P40: Enhanced performance for growing production workloads with consistent IOPS demands. ,
P50: Optimized for enterprise-grade applications needing sustained high throughput. ,
P60: High-capacity tier for large databases and analytics workloads with elevated IOPS. ,
P70: Designed for mission-critical systems requiring ultra-low latency and high concurrency. ,
P80: Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads. ,
PremiumV2_LRS: Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads. ,
UltraSSD_LRS: High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: Server supports Microsoft Entra authentication. ,
Disabled: Server doesn't support Microsoft Entra authentication. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: Server supports password based authentication. ,
Disabled: Server doesn't support password based authentication. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a server. ,
Enum:
{
SystemManaged: Encryption managed by Azure using platform managed keys for simplicity and compliance. ,
AzureKeyVault: Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
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: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: Server is configured to create geographically redundant backups. ,
Disabled: Server is not configured to create geographically redundant backups. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. ,
Enum:
{
Enabled: Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server. ,
Disabled: Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: High availability is disabled for the server. ,
ZoneRedundant: High availability is enabled for the server, with standby server in a different availability zone than that of the primary. ,
SameZone: High availability is enabled for the server, with standby server in the same availability zone as the primary. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: High availability is not enabled for the server. ,
CreatingStandby: Standby server is being created. ,
ReplicatingData: Data is being replicated to the standby server. ,
FailingOver: Failover operation to the standby server is in progress. ,
Healthy: Standby server is healthy and ready to take over in case of a failover. ,
RemovingStandby: Standby server is being removed. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. ,
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 to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: Identifier of the server to be used as the source of the new server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a server. Required only in case that you want to promote a server. ,
Required: False ,
}
{
role:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: Read replica is fully synchronized and actively replicating data from the primary server. ,
Catchup: Read replica is behind the primary server and is currently catching up with pending changes. ,
Provisioning: Read replica is being created and is in process of getting initialized. ,
Updating: Read replica is undergoing some changes it can be changing compute size of promoting it to primary server. ,
Broken: Replication has failed or been interrupted. ,
Reconfiguring: Read replica is being reconfigured, possibly due to changes in source or settings. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server. ,
Enum:
{
Standalone: Read replica will become an independent server. ,
Switchover: Read replica will swap roles with primary server. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only. ,
Enum:
{
Planned: The operation will wait for data in the read replica to be fully synchronized with its source server, before it initiates the operation. ,
Forced: The operation will not wait for data in the read replica to be synchronized with its source server, before it initiates the operation. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new server. ,
Enum:
{
Default: If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'. ,
Create: Operation creates a new server. ,
Update: Operation updates an existing server. ,
PointInTimeRestore: Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time. ,
GeoRestore: Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled. ,
Replica: Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary. ,
ReviveDropped: Operation creates a new server, initialized with the backup of a server that was recently deleted. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified server. ,
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: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDatabaseName:
{
Description: Default database name for the elastic cluster. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Servers_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "sku": [
          {
            "#name": "tier",
            "Enum": {
              "new": [
                [
                  "Burstable",
                  "Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements."
                ],
                [
                  "GeneralPurpose",
                  "Balanced compute and memory for most workloads, offering scalable performance and I/O throughput."
                ],
                [
                  "MemoryOptimized",
                  "High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency."
                ]
              ],
              "old": [
                [
                  "Burstable",
                  ""
                ],
                [
                  "GeneralPurpose",
                  ""
                ],
                [
                  "MemoryOptimized",
                  ""
                ]
              ]
            }
          }
        ],
        "identity": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "None",
                  "No managed identity is assigned to the server."
                ],
                [
                  "UserAssigned",
                  "One or more managed identities provided by the user are assigned to the server."
                ],
                [
                  "SystemAssigned",
                  "Azure automatically creates and manages the identity associated to the lifecycle of the server."
                ],
                [
                  "SystemAssigned,UserAssigned",
                  "Both system-assigned and user-assigned identities are assigned to the server."
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ]
            }
          }
        ],
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "17",
                  "PostgreSQL 17."
                ],
                [
                  "16",
                  "PostgreSQL 16."
                ],
                [
                  "15",
                  "PostgreSQL 15."
                ],
                [
                  "14",
                  "PostgreSQL 14."
                ],
                [
                  "13",
                  "PostgreSQL 13."
                ],
                [
                  "12",
                  "PostgreSQL 12."
                ],
                [
                  "11",
                  "PostgreSQL 11."
                ]
              ],
              "old": [
                [
                  "17",
                  ""
                ],
                [
                  "16",
                  ""
                ],
                [
                  "15",
                  ""
                ],
                [
                  "14",
                  ""
                ],
                [
                  "13",
                  ""
                ],
                [
                  "12",
                  ""
                ],
                [
                  "11",
                  ""
                ]
              ]
            }
          },
          {
            "storage": [
              {
                "#name": "autoGrow",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size."
                    ],
                    [
                      "Disabled",
                      "Server should not automatically grow storage size when available space is nearing zero."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "tier",
                "Enum": {
                  "new": [
                    [
                      "P1",
                      "Entry-level SSD for minimal IOPS, ideal for light development or testing workloads."
                    ],
                    [
                      "P2",
                      "Slightly higher IOPS for small-scale applications needing consistent low latency."
                    ],
                    [
                      "P3",
                      "Balanced performance for basic production workloads with moderate throughput."
                    ],
                    [
                      "P4",
                      "Enhanced IOPS for growing apps with predictable performance needs."
                    ],
                    [
                      "P6",
                      "Mid-tier SSD for steady workloads requiring reliable throughput and latency."
                    ],
                    [
                      "P10",
                      "Popular choice for general-purpose production workloads with scalable performance."
                    ],
                    [
                      "P15",
                      "High IOPS tier for demanding apps with frequent read/write operations."
                    ],
                    [
                      "P20",
                      "Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads."
                    ],
                    [
                      "P30",
                      "Balanced tier for moderate throughput and latency-sensitive applications."
                    ],
                    [
                      "P40",
                      "Enhanced performance for growing production workloads with consistent IOPS demands."
                    ],
                    [
                      "P50",
                      "Optimized for enterprise-grade applications needing sustained high throughput."
                    ],
                    [
                      "P60",
                      "High-capacity tier for large databases and analytics workloads with elevated IOPS."
                    ],
                    [
                      "P70",
                      "Designed for mission-critical systems requiring ultra-low latency and high concurrency."
                    ],
                    [
                      "P80",
                      "Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads."
                    ]
                  ],
                  "old": [
                    [
                      "P1",
                      ""
                    ],
                    [
                      "P2",
                      ""
                    ],
                    [
                      "P3",
                      ""
                    ],
                    [
                      "P4",
                      ""
                    ],
                    [
                      "P6",
                      ""
                    ],
                    [
                      "P10",
                      ""
                    ],
                    [
                      "P15",
                      ""
                    ],
                    [
                      "P20",
                      ""
                    ],
                    [
                      "P30",
                      ""
                    ],
                    [
                      "P40",
                      ""
                    ],
                    [
                      "P50",
                      ""
                    ],
                    [
                      "P60",
                      ""
                    ],
                    [
                      "P70",
                      ""
                    ],
                    [
                      "P80",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "Premium_LRS",
                      "Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads."
                    ],
                    [
                      "PremiumV2_LRS",
                      "Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads."
                    ],
                    [
                      "UltraSSD_LRS",
                      "High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications."
                    ]
                  ],
                  "old": [
                    [
                      "Premium_LRS",
                      ""
                    ],
                    [
                      "PremiumV2_LRS",
                      ""
                    ],
                    [
                      "UltraSSD_LRS",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "backup": [
              {
                "#name": "geoRedundantBackup",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server is configured to create geographically redundant backups."
                    ],
                    [
                      "Disabled",
                      "Server is not configured to create geographically redundant backups."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "highAvailability": [
              {
                "#name": "mode",
                "Enum": {
                  "new": [
                    [
                      "Disabled",
                      "High availability is disabled for the server."
                    ],
                    [
                      "ZoneRedundant",
                      "High availability is enabled for the server, with standby server in a different availability zone than that of the primary."
                    ],
                    [
                      "SameZone",
                      "High availability is enabled for the server, with standby server in the same availability zone as the primary."
                    ]
                  ],
                  "old": [
                    [
                      "Disabled",
                      ""
                    ],
                    [
                      "ZoneRedundant",
                      ""
                    ],
                    [
                      "SameZone",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "NotEnabled",
                      "High availability is not enabled for the server."
                    ],
                    [
                      "CreatingStandby",
                      "Standby server is being created."
                    ],
                    [
                      "ReplicatingData",
                      "Data is being replicated to the standby server."
                    ],
                    [
                      "FailingOver",
                      "Failover operation to the standby server is in progress."
                    ],
                    [
                      "Healthy",
                      "Standby server is healthy and ready to take over in case of a failover."
                    ],
                    [
                      "RemovingStandby",
                      "Standby server is being removed."
                    ]
                  ],
                  "old": [
                    [
                      "NotEnabled",
                      ""
                    ],
                    [
                      "CreatingStandby",
                      ""
                    ],
                    [
                      "ReplicatingData",
                      ""
                    ],
                    [
                      "FailingOver",
                      ""
                    ],
                    [
                      "Healthy",
                      ""
                    ],
                    [
                      "RemovingStandby",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "authConfig": [
              {
                "#name": "activeDirectoryAuth",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server supports Microsoft Entra authentication."
                    ],
                    [
                      "Disabled",
                      "Server doesn't support Microsoft Entra authentication."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "passwordAuth",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server supports password based authentication."
                    ],
                    [
                      "Disabled",
                      "Server doesn't support password based authentication."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "dataEncryption": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "SystemManaged",
                      "Encryption managed by Azure using platform managed keys for simplicity and compliance."
                    ],
                    [
                      "AzureKeyVault",
                      "Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security."
                    ]
                  ],
                  "old": [
                    [
                      "SystemManaged",
                      ""
                    ],
                    [
                      "AzureKeyVault",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "primaryEncryptionKeyStatus",
                "Enum": {
                  "new": [
                    [
                      "Valid",
                      "Key is valid and can be used for encryption."
                    ],
                    [
                      "Invalid",
                      "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                    ]
                  ],
                  "old": [
                    [
                      "Valid",
                      ""
                    ],
                    [
                      "Invalid",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "geoBackupEncryptionKeyStatus",
                "Enum": {
                  "new": [
                    [
                      "Valid",
                      "Key is valid and can be used for encryption."
                    ],
                    [
                      "Invalid",
                      "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                    ]
                  ],
                  "old": [
                    [
                      "Valid",
                      ""
                    ],
                    [
                      "Invalid",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "createMode",
            "Enum": {
              "new": [
                [
                  "Default",
                  "It's equivalent to 'Update'."
                ],
                [
                  "Update",
                  "Operation updates an existing server."
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Update",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "replicationRole",
            "Enum": {
              "new": [
                [
                  "None",
                  "No replication role assigned; the server operates independently."
                ],
                [
                  "Primary",
                  "Acts as the source server for replication to one or more replicas."
                ],
                [
                  "AsyncReplica",
                  "Receives data asynchronously from a primary server within the same region."
                ],
                [
                  "GeoAsyncReplica",
                  "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Primary",
                  ""
                ],
                [
                  "AsyncReplica",
                  ""
                ],
                [
                  "GeoAsyncReplica",
                  ""
                ]
              ]
            }
          },
          {
            "replica": [
              {
                "#name": "role",
                "Enum": {
                  "new": [
                    [
                      "None",
                      "No replication role assigned; the server operates independently."
                    ],
                    [
                      "Primary",
                      "Acts as the source server for replication to one or more replicas."
                    ],
                    [
                      "AsyncReplica",
                      "Receives data asynchronously from a primary server within the same region."
                    ],
                    [
                      "GeoAsyncReplica",
                      "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "Primary",
                      ""
                    ],
                    [
                      "AsyncReplica",
                      ""
                    ],
                    [
                      "GeoAsyncReplica",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "replicationState",
                "Enum": {
                  "new": [
                    [
                      "Active",
                      "Read replica is fully synchronized and actively replicating data from the primary server."
                    ],
                    [
                      "Catchup",
                      "Read replica is behind the primary server and is currently catching up with pending changes."
                    ],
                    [
                      "Provisioning",
                      "Read replica is being created and is in process of getting initialized."
                    ],
                    [
                      "Updating",
                      "Read replica is undergoing some changes it can be changing compute size of promoting it to primary server."
                    ],
                    [
                      "Broken",
                      "Replication has failed or been interrupted."
                    ],
                    [
                      "Reconfiguring",
                      "Read replica is being reconfigured, possibly due to changes in source or settings."
                    ]
                  ],
                  "old": [
                    [
                      "Active",
                      "The read replica server is fully synchronized and actively replicating data from the primary server."
                    ],
                    [
                      "Catchup",
                      "The read replica server is behind the primary server and is currently catching up with pending changes."
                    ],
                    [
                      "Provisioning",
                      "The read replica server is being created and is in process of getting initialized."
                    ],
                    [
                      "Updating",
                      "The read replica server is undergoing some changes it can be changing compute size of promoting it to primary server."
                    ],
                    [
                      "Broken",
                      "Replication has failed or been interrupted."
                    ],
                    [
                      "Reconfiguring",
                      "The read replica server is being reconfigured, possibly due to changes in source or settings."
                    ]
                  ]
                }
              }
            ]
          },
          {
            "network": [
              {
                "#name": "publicNetworkAccess",
                "Description": {
                  "new": "Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed.",
                  "old": "Indicates if public network access is enabled or not."
                },
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server."
                    ],
                    [
                      "Disabled",
                      "Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ 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: Parameters required to update a server. ,
Required: True ,
}
{
sku:
{
Description: Compute tier and size of a server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a server. ,
Required: False ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements. ,
GeneralPurpose: Balanced compute and memory for most workloads, offering scalable performance and I/O throughput. ,
MemoryOptimized: High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: Map of user assigned managed identities. ,
Required: False ,
}
object ,
principalId:
{
Description: Identifier of the object of the service principal associated to the user assigned managed identity. ,
Required: False ,
}
string ,
type:
{
Description: Types of identities associated with a server. ,
Enum:
{
None: No managed identity is assigned to the server. ,
UserAssigned: One or more managed identities provided by the user are assigned to the server. ,
SystemAssigned: Azure automatically creates and manages the identity associated to the lifecycle of the server. ,
SystemAssigned,UserAssigned: Both system-assigned and user-assigned identities are assigned to the server. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server. ,
Required: False ,
}
{
administratorLogin:
{
Description: Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Enum:
{
17: PostgreSQL 17. ,
16: PostgreSQL 16. ,
15: PostgreSQL 15. ,
14: PostgreSQL 14. ,
13: PostgreSQL 13. ,
12: PostgreSQL 12. ,
11: PostgreSQL 11. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size. ,
Disabled: Server should not automatically grow storage size when available space is nearing zero. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a server. ,
Enum:
{
P1: Entry-level SSD for minimal IOPS, ideal for light development or testing workloads. ,
P2: Slightly higher IOPS for small-scale applications needing consistent low latency. ,
P3: Balanced performance for basic production workloads with moderate throughput. ,
P4: Enhanced IOPS for growing apps with predictable performance needs. ,
P6: Mid-tier SSD for steady workloads requiring reliable throughput and latency. ,
P10: Popular choice for general-purpose production workloads with scalable performance. ,
P15: High IOPS tier for demanding apps with frequent read/write operations. ,
P20: Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads. ,
P30: Balanced tier for moderate throughput and latency-sensitive applications. ,
P40: Enhanced performance for growing production workloads with consistent IOPS demands. ,
P50: Optimized for enterprise-grade applications needing sustained high throughput. ,
P60: High-capacity tier for large databases and analytics workloads with elevated IOPS. ,
P70: Designed for mission-critical systems requiring ultra-low latency and high concurrency. ,
P80: Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads. ,
PremiumV2_LRS: Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads. ,
UltraSSD_LRS: High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications. ,
}
,
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: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: Server is configured to create geographically redundant backups. ,
Disabled: Server is not configured to create geographically redundant backups. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: High availability is disabled for the server. ,
ZoneRedundant: High availability is enabled for the server, with standby server in a different availability zone than that of the primary. ,
SameZone: High availability is enabled for the server, with standby server in the same availability zone as the primary. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: High availability is not enabled for the server. ,
CreatingStandby: Standby server is being created. ,
ReplicatingData: Data is being replicated to the standby server. ,
FailingOver: Failover operation to the standby server is in progress. ,
Healthy: Standby server is healthy and ready to take over in case of a failover. ,
RemovingStandby: Standby server is being removed. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. ,
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 to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
authConfig:
{
Description: Authentication configuration properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: Server supports Microsoft Entra authentication. ,
Disabled: Server doesn't support Microsoft Entra authentication. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: Server supports password based authentication. ,
Disabled: Server doesn't support password based authentication. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a server. ,
Enum:
{
SystemManaged: Encryption managed by Azure using platform managed keys for simplicity and compliance. ,
AzureKeyVault: Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Update mode of an existing server. ,
Enum:
{
Default: It's equivalent to 'Update'. ,
Update: Operation updates an existing server. ,
}
,
Required: False ,
}
enum ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
replica:
{
Description: Read replica properties of a server. Required only in case that you want to promote a server. ,
Required: False ,
}
{
role:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: Read replica is fully synchronized and actively replicating data from the primary server. ,
Catchup: Read replica is behind the primary server and is currently catching up with pending changes. ,
Provisioning: Read replica is being created and is in process of getting initialized. ,
Updating: Read replica is undergoing some changes it can be changing compute size of promoting it to primary server. ,
Broken: Replication has failed or been interrupted. ,
Reconfiguring: Read replica is being reconfigured, possibly due to changes in source or settings. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server. ,
Enum:
{
Standalone: Read replica will become an independent server. ,
Switchover: Read replica will swap roles with primary server. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only. ,
Enum:
{
Planned: The operation will wait for data in the read replica to be fully synchronized with its source server, before it initiates the operation. ,
Forced: The operation will not wait for data in the read replica to be synchronized with its source server, before it initiates the operation. ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. ,
Enum:
{
Enabled: Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server. ,
Disabled: Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
}
,
cluster:
{
Description: Cluster properties of a server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDatabaseName:
{
Description: Default database name for the elastic cluster. ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Servers_Get",
  "$responses": {
    "200": {
      "$properties": {
        "sku": [
          {
            "#name": "tier",
            "Enum": {
              "new": [
                [
                  "Burstable",
                  "Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements."
                ],
                [
                  "GeneralPurpose",
                  "Balanced compute and memory for most workloads, offering scalable performance and I/O throughput."
                ],
                [
                  "MemoryOptimized",
                  "High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency."
                ]
              ],
              "old": [
                [
                  "Burstable",
                  ""
                ],
                [
                  "GeneralPurpose",
                  ""
                ],
                [
                  "MemoryOptimized",
                  ""
                ]
              ]
            }
          }
        ],
        "identity": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "None",
                  "No managed identity is assigned to the server."
                ],
                [
                  "UserAssigned",
                  "One or more managed identities provided by the user are assigned to the server."
                ],
                [
                  "SystemAssigned",
                  "Azure automatically creates and manages the identity associated to the lifecycle of the server."
                ],
                [
                  "SystemAssigned,UserAssigned",
                  "Both system-assigned and user-assigned identities are assigned to the server."
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ]
            }
          }
        ],
        "properties": [
          {
            "#name": "version",
            "Enum": {
              "new": [
                [
                  "17",
                  "PostgreSQL 17."
                ],
                [
                  "16",
                  "PostgreSQL 16."
                ],
                [
                  "15",
                  "PostgreSQL 15."
                ],
                [
                  "14",
                  "PostgreSQL 14."
                ],
                [
                  "13",
                  "PostgreSQL 13."
                ],
                [
                  "12",
                  "PostgreSQL 12."
                ],
                [
                  "11",
                  "PostgreSQL 11."
                ]
              ],
              "old": [
                [
                  "17",
                  ""
                ],
                [
                  "16",
                  ""
                ],
                [
                  "15",
                  ""
                ],
                [
                  "14",
                  ""
                ],
                [
                  "13",
                  ""
                ],
                [
                  "12",
                  ""
                ],
                [
                  "11",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "state",
            "Enum": {
              "new": [
                [
                  "Ready",
                  "Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level."
                ],
                [
                  "Dropping",
                  "Server is being deleted."
                ],
                [
                  "Disabled",
                  "Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription."
                ],
                [
                  "Starting",
                  "PostgreSQL database engine is being restarted."
                ],
                [
                  "Stopping",
                  "Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated."
                ],
                [
                  "Stopped",
                  "Compute resources associated with the server are being stopped and deallocated."
                ],
                [
                  "Updating",
                  "Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine."
                ],
                [
                  "Restarting",
                  "PostgreSQL database engine is being restarted."
                ],
                [
                  "Inaccessible",
                  "Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state."
                ],
                [
                  "Provisioning",
                  "Server is in the process of being created."
                ]
              ],
              "old": [
                [
                  "Ready",
                  ""
                ],
                [
                  "Dropping",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ],
                [
                  "Starting",
                  ""
                ],
                [
                  "Stopping",
                  ""
                ],
                [
                  "Stopped",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Restarting",
                  ""
                ],
                [
                  "Inaccessible",
                  ""
                ],
                [
                  "Provisioning",
                  ""
                ]
              ]
            }
          },
          {
            "storage": [
              {
                "#name": "autoGrow",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size."
                    ],
                    [
                      "Disabled",
                      "Server should not automatically grow storage size when available space is nearing zero."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "tier",
                "Enum": {
                  "new": [
                    [
                      "P1",
                      "Entry-level SSD for minimal IOPS, ideal for light development or testing workloads."
                    ],
                    [
                      "P2",
                      "Slightly higher IOPS for small-scale applications needing consistent low latency."
                    ],
                    [
                      "P3",
                      "Balanced performance for basic production workloads with moderate throughput."
                    ],
                    [
                      "P4",
                      "Enhanced IOPS for growing apps with predictable performance needs."
                    ],
                    [
                      "P6",
                      "Mid-tier SSD for steady workloads requiring reliable throughput and latency."
                    ],
                    [
                      "P10",
                      "Popular choice for general-purpose production workloads with scalable performance."
                    ],
                    [
                      "P15",
                      "High IOPS tier for demanding apps with frequent read/write operations."
                    ],
                    [
                      "P20",
                      "Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads."
                    ],
                    [
                      "P30",
                      "Balanced tier for moderate throughput and latency-sensitive applications."
                    ],
                    [
                      "P40",
                      "Enhanced performance for growing production workloads with consistent IOPS demands."
                    ],
                    [
                      "P50",
                      "Optimized for enterprise-grade applications needing sustained high throughput."
                    ],
                    [
                      "P60",
                      "High-capacity tier for large databases and analytics workloads with elevated IOPS."
                    ],
                    [
                      "P70",
                      "Designed for mission-critical systems requiring ultra-low latency and high concurrency."
                    ],
                    [
                      "P80",
                      "Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads."
                    ]
                  ],
                  "old": [
                    [
                      "P1",
                      ""
                    ],
                    [
                      "P2",
                      ""
                    ],
                    [
                      "P3",
                      ""
                    ],
                    [
                      "P4",
                      ""
                    ],
                    [
                      "P6",
                      ""
                    ],
                    [
                      "P10",
                      ""
                    ],
                    [
                      "P15",
                      ""
                    ],
                    [
                      "P20",
                      ""
                    ],
                    [
                      "P30",
                      ""
                    ],
                    [
                      "P40",
                      ""
                    ],
                    [
                      "P50",
                      ""
                    ],
                    [
                      "P60",
                      ""
                    ],
                    [
                      "P70",
                      ""
                    ],
                    [
                      "P80",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "Premium_LRS",
                      "Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads."
                    ],
                    [
                      "PremiumV2_LRS",
                      "Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads."
                    ],
                    [
                      "UltraSSD_LRS",
                      "High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications."
                    ]
                  ],
                  "old": [
                    [
                      "Premium_LRS",
                      ""
                    ],
                    [
                      "PremiumV2_LRS",
                      ""
                    ],
                    [
                      "UltraSSD_LRS",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "authConfig": [
              {
                "#name": "activeDirectoryAuth",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server supports Microsoft Entra authentication."
                    ],
                    [
                      "Disabled",
                      "Server doesn't support Microsoft Entra authentication."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "passwordAuth",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server supports password based authentication."
                    ],
                    [
                      "Disabled",
                      "Server doesn't support password based authentication."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "dataEncryption": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "SystemManaged",
                      "Encryption managed by Azure using platform managed keys for simplicity and compliance."
                    ],
                    [
                      "AzureKeyVault",
                      "Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security."
                    ]
                  ],
                  "old": [
                    [
                      "SystemManaged",
                      ""
                    ],
                    [
                      "AzureKeyVault",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "primaryEncryptionKeyStatus",
                "Enum": {
                  "new": [
                    [
                      "Valid",
                      "Key is valid and can be used for encryption."
                    ],
                    [
                      "Invalid",
                      "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                    ]
                  ],
                  "old": [
                    [
                      "Valid",
                      ""
                    ],
                    [
                      "Invalid",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "geoBackupEncryptionKeyStatus",
                "Enum": {
                  "new": [
                    [
                      "Valid",
                      "Key is valid and can be used for encryption."
                    ],
                    [
                      "Invalid",
                      "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                    ]
                  ],
                  "old": [
                    [
                      "Valid",
                      ""
                    ],
                    [
                      "Invalid",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "backup": [
              {
                "#name": "geoRedundantBackup",
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Server is configured to create geographically redundant backups."
                    ],
                    [
                      "Disabled",
                      "Server is not configured to create geographically redundant backups."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "network": [
              {
                "#name": "publicNetworkAccess",
                "Description": {
                  "new": "Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed.",
                  "old": "Indicates if public network access is enabled or not."
                },
                "Enum": {
                  "new": [
                    [
                      "Enabled",
                      "Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server."
                    ],
                    [
                      "Disabled",
                      "Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints."
                    ]
                  ],
                  "old": [
                    [
                      "Enabled",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "highAvailability": [
              {
                "#name": "mode",
                "Enum": {
                  "new": [
                    [
                      "Disabled",
                      "High availability is disabled for the server."
                    ],
                    [
                      "ZoneRedundant",
                      "High availability is enabled for the server, with standby server in a different availability zone than that of the primary."
                    ],
                    [
                      "SameZone",
                      "High availability is enabled for the server, with standby server in the same availability zone as the primary."
                    ]
                  ],
                  "old": [
                    [
                      "Disabled",
                      ""
                    ],
                    [
                      "ZoneRedundant",
                      ""
                    ],
                    [
                      "SameZone",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "NotEnabled",
                      "High availability is not enabled for the server."
                    ],
                    [
                      "CreatingStandby",
                      "Standby server is being created."
                    ],
                    [
                      "ReplicatingData",
                      "Data is being replicated to the standby server."
                    ],
                    [
                      "FailingOver",
                      "Failover operation to the standby server is in progress."
                    ],
                    [
                      "Healthy",
                      "Standby server is healthy and ready to take over in case of a failover."
                    ],
                    [
                      "RemovingStandby",
                      "Standby server is being removed."
                    ]
                  ],
                  "old": [
                    [
                      "NotEnabled",
                      ""
                    ],
                    [
                      "CreatingStandby",
                      ""
                    ],
                    [
                      "ReplicatingData",
                      ""
                    ],
                    [
                      "FailingOver",
                      ""
                    ],
                    [
                      "Healthy",
                      ""
                    ],
                    [
                      "RemovingStandby",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "replicationRole",
            "Enum": {
              "new": [
                [
                  "None",
                  "No replication role assigned; the server operates independently."
                ],
                [
                  "Primary",
                  "Acts as the source server for replication to one or more replicas."
                ],
                [
                  "AsyncReplica",
                  "Receives data asynchronously from a primary server within the same region."
                ],
                [
                  "GeoAsyncReplica",
                  "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Primary",
                  ""
                ],
                [
                  "AsyncReplica",
                  ""
                ],
                [
                  "GeoAsyncReplica",
                  ""
                ]
              ]
            }
          },
          {
            "replica": [
              {
                "#name": "role",
                "Enum": {
                  "new": [
                    [
                      "None",
                      "No replication role assigned; the server operates independently."
                    ],
                    [
                      "Primary",
                      "Acts as the source server for replication to one or more replicas."
                    ],
                    [
                      "AsyncReplica",
                      "Receives data asynchronously from a primary server within the same region."
                    ],
                    [
                      "GeoAsyncReplica",
                      "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "Primary",
                      ""
                    ],
                    [
                      "AsyncReplica",
                      ""
                    ],
                    [
                      "GeoAsyncReplica",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "replicationState",
                "Enum": {
                  "new": [
                    [
                      "Active",
                      "Read replica is fully synchronized and actively replicating data from the primary server."
                    ],
                    [
                      "Catchup",
                      "Read replica is behind the primary server and is currently catching up with pending changes."
                    ],
                    [
                      "Provisioning",
                      "Read replica is being created and is in process of getting initialized."
                    ],
                    [
                      "Updating",
                      "Read replica is undergoing some changes it can be changing compute size of promoting it to primary server."
                    ],
                    [
                      "Broken",
                      "Replication has failed or been interrupted."
                    ],
                    [
                      "Reconfiguring",
                      "Read replica is being reconfigured, possibly due to changes in source or settings."
                    ]
                  ],
                  "old": [
                    [
                      "Active",
                      "The read replica server is fully synchronized and actively replicating data from the primary server."
                    ],
                    [
                      "Catchup",
                      "The read replica server is behind the primary server and is currently catching up with pending changes."
                    ],
                    [
                      "Provisioning",
                      "The read replica server is being created and is in process of getting initialized."
                    ],
                    [
                      "Updating",
                      "The read replica server is undergoing some changes it can be changing compute size of promoting it to primary server."
                    ],
                    [
                      "Broken",
                      "Replication has failed or been interrupted."
                    ],
                    [
                      "Reconfiguring",
                      "The read replica server is being reconfigured, possibly due to changes in source or settings."
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "createMode",
            "Enum": {
              "new": [
                [
                  "Default",
                  "If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'."
                ],
                [
                  "Create",
                  "Operation creates a new server."
                ],
                [
                  "Update",
                  "Operation updates an existing server."
                ],
                [
                  "PointInTimeRestore",
                  "Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time."
                ],
                [
                  "GeoRestore",
                  "Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled."
                ],
                [
                  "Replica",
                  "Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary."
                ],
                [
                  "ReviveDropped",
                  "Operation creates a new server, initialized with the backup of a server that was recently deleted."
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Create",
                  ""
                ],
                [
                  "Update",
                  ""
                ],
                [
                  "PointInTimeRestore",
                  ""
                ],
                [
                  "GeoRestore",
                  ""
                ],
                [
                  "Replica",
                  ""
                ],
                [
                  "ReviveDropped",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Compute tier and size of a server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements. ,
GeneralPurpose: Balanced compute and memory for most workloads, offering scalable performance and I/O throughput. ,
MemoryOptimized: High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: Map of user assigned managed identities. ,
Required: False ,
}
object ,
principalId:
{
Description: Identifier of the object of the service principal associated to the user assigned managed identity. ,
Required: False ,
}
string ,
type:
{
Description: Types of identities associated with a server. ,
Enum:
{
None: No managed identity is assigned to the server. ,
UserAssigned: One or more managed identities provided by the user are assigned to the server. ,
SystemAssigned: Azure automatically creates and manages the identity associated to the lifecycle of the server. ,
SystemAssigned,UserAssigned: Both system-assigned and user-assigned identities are assigned to the server. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a server. ,
Required: False ,
}
{
administratorLogin:
{
Description: Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Enum:
{
17: PostgreSQL 17. ,
16: PostgreSQL 16. ,
15: PostgreSQL 15. ,
14: PostgreSQL 14. ,
13: PostgreSQL 13. ,
12: PostgreSQL 12. ,
11: PostgreSQL 11. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a server. ,
Enum:
{
Ready: Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level. ,
Dropping: Server is being deleted. ,
Disabled: Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription. ,
Starting: PostgreSQL database engine is being restarted. ,
Stopping: Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated. ,
Stopped: Compute resources associated with the server are being stopped and deallocated. ,
Updating: Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine. ,
Restarting: PostgreSQL database engine is being restarted. ,
Inaccessible: Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state. ,
Provisioning: Server is in the process of being created. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size. ,
Disabled: Server should not automatically grow storage size when available space is nearing zero. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a server. ,
Enum:
{
P1: Entry-level SSD for minimal IOPS, ideal for light development or testing workloads. ,
P2: Slightly higher IOPS for small-scale applications needing consistent low latency. ,
P3: Balanced performance for basic production workloads with moderate throughput. ,
P4: Enhanced IOPS for growing apps with predictable performance needs. ,
P6: Mid-tier SSD for steady workloads requiring reliable throughput and latency. ,
P10: Popular choice for general-purpose production workloads with scalable performance. ,
P15: High IOPS tier for demanding apps with frequent read/write operations. ,
P20: Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads. ,
P30: Balanced tier for moderate throughput and latency-sensitive applications. ,
P40: Enhanced performance for growing production workloads with consistent IOPS demands. ,
P50: Optimized for enterprise-grade applications needing sustained high throughput. ,
P60: High-capacity tier for large databases and analytics workloads with elevated IOPS. ,
P70: Designed for mission-critical systems requiring ultra-low latency and high concurrency. ,
P80: Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads. ,
PremiumV2_LRS: Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads. ,
UltraSSD_LRS: High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: Server supports Microsoft Entra authentication. ,
Disabled: Server doesn't support Microsoft Entra authentication. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: Server supports password based authentication. ,
Disabled: Server doesn't support password based authentication. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a server. ,
Enum:
{
SystemManaged: Encryption managed by Azure using platform managed keys for simplicity and compliance. ,
AzureKeyVault: Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
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: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: Server is configured to create geographically redundant backups. ,
Disabled: Server is not configured to create geographically redundant backups. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. ,
Enum:
{
Enabled: Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server. ,
Disabled: Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: High availability is disabled for the server. ,
ZoneRedundant: High availability is enabled for the server, with standby server in a different availability zone than that of the primary. ,
SameZone: High availability is enabled for the server, with standby server in the same availability zone as the primary. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: High availability is not enabled for the server. ,
CreatingStandby: Standby server is being created. ,
ReplicatingData: Data is being replicated to the standby server. ,
FailingOver: Failover operation to the standby server is in progress. ,
Healthy: Standby server is healthy and ready to take over in case of a failover. ,
RemovingStandby: Standby server is being removed. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. ,
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 to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: Identifier of the server to be used as the source of the new server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a server. Required only in case that you want to promote a server. ,
Required: False ,
}
{
role:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: Read replica is fully synchronized and actively replicating data from the primary server. ,
Catchup: Read replica is behind the primary server and is currently catching up with pending changes. ,
Provisioning: Read replica is being created and is in process of getting initialized. ,
Updating: Read replica is undergoing some changes it can be changing compute size of promoting it to primary server. ,
Broken: Replication has failed or been interrupted. ,
Reconfiguring: Read replica is being reconfigured, possibly due to changes in source or settings. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server. ,
Enum:
{
Standalone: Read replica will become an independent server. ,
Switchover: Read replica will swap roles with primary server. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only. ,
Enum:
{
Planned: The operation will wait for data in the read replica to be fully synchronized with its source server, before it initiates the operation. ,
Forced: The operation will not wait for data in the read replica to be synchronized with its source server, before it initiates the operation. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new server. ,
Enum:
{
Default: If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'. ,
Create: Operation creates a new server. ,
Update: Operation updates an existing server. ,
PointInTimeRestore: Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time. ,
GeoRestore: Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled. ,
Replica: Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary. ,
ReviveDropped: Operation creates a new server, initialized with the backup of a server that was recently deleted. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified server. ,
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: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDatabaseName:
{
Description: Default database name for the elastic cluster. ,
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_ListByResourceGroup (updated)
Description :  Lists all servers in a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "sku": [
              {
                "#name": "tier",
                "Enum": {
                  "new": [
                    [
                      "Burstable",
                      "Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements."
                    ],
                    [
                      "GeneralPurpose",
                      "Balanced compute and memory for most workloads, offering scalable performance and I/O throughput."
                    ],
                    [
                      "MemoryOptimized",
                      "High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency."
                    ]
                  ],
                  "old": [
                    [
                      "Burstable",
                      ""
                    ],
                    [
                      "GeneralPurpose",
                      ""
                    ],
                    [
                      "MemoryOptimized",
                      ""
                    ]
                  ]
                }
              }
            ],
            "identity": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "None",
                      "No managed identity is assigned to the server."
                    ],
                    [
                      "UserAssigned",
                      "One or more managed identities provided by the user are assigned to the server."
                    ],
                    [
                      "SystemAssigned",
                      "Azure automatically creates and manages the identity associated to the lifecycle of the server."
                    ],
                    [
                      "SystemAssigned,UserAssigned",
                      "Both system-assigned and user-assigned identities are assigned to the server."
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "UserAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned,UserAssigned",
                      ""
                    ]
                  ]
                }
              }
            ],
            "properties": [
              {
                "#name": "version",
                "Enum": {
                  "new": [
                    [
                      "17",
                      "PostgreSQL 17."
                    ],
                    [
                      "16",
                      "PostgreSQL 16."
                    ],
                    [
                      "15",
                      "PostgreSQL 15."
                    ],
                    [
                      "14",
                      "PostgreSQL 14."
                    ],
                    [
                      "13",
                      "PostgreSQL 13."
                    ],
                    [
                      "12",
                      "PostgreSQL 12."
                    ],
                    [
                      "11",
                      "PostgreSQL 11."
                    ]
                  ],
                  "old": [
                    [
                      "17",
                      ""
                    ],
                    [
                      "16",
                      ""
                    ],
                    [
                      "15",
                      ""
                    ],
                    [
                      "14",
                      ""
                    ],
                    [
                      "13",
                      ""
                    ],
                    [
                      "12",
                      ""
                    ],
                    [
                      "11",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "Ready",
                      "Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level."
                    ],
                    [
                      "Dropping",
                      "Server is being deleted."
                    ],
                    [
                      "Disabled",
                      "Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription."
                    ],
                    [
                      "Starting",
                      "PostgreSQL database engine is being restarted."
                    ],
                    [
                      "Stopping",
                      "Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated."
                    ],
                    [
                      "Stopped",
                      "Compute resources associated with the server are being stopped and deallocated."
                    ],
                    [
                      "Updating",
                      "Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine."
                    ],
                    [
                      "Restarting",
                      "PostgreSQL database engine is being restarted."
                    ],
                    [
                      "Inaccessible",
                      "Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state."
                    ],
                    [
                      "Provisioning",
                      "Server is in the process of being created."
                    ]
                  ],
                  "old": [
                    [
                      "Ready",
                      ""
                    ],
                    [
                      "Dropping",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ],
                    [
                      "Starting",
                      ""
                    ],
                    [
                      "Stopping",
                      ""
                    ],
                    [
                      "Stopped",
                      ""
                    ],
                    [
                      "Updating",
                      ""
                    ],
                    [
                      "Restarting",
                      ""
                    ],
                    [
                      "Inaccessible",
                      ""
                    ],
                    [
                      "Provisioning",
                      ""
                    ]
                  ]
                }
              },
              {
                "storage": [
                  {
                    "#name": "autoGrow",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size."
                        ],
                        [
                          "Disabled",
                          "Server should not automatically grow storage size when available space is nearing zero."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "tier",
                    "Enum": {
                      "new": [
                        [
                          "P1",
                          "Entry-level SSD for minimal IOPS, ideal for light development or testing workloads."
                        ],
                        [
                          "P2",
                          "Slightly higher IOPS for small-scale applications needing consistent low latency."
                        ],
                        [
                          "P3",
                          "Balanced performance for basic production workloads with moderate throughput."
                        ],
                        [
                          "P4",
                          "Enhanced IOPS for growing apps with predictable performance needs."
                        ],
                        [
                          "P6",
                          "Mid-tier SSD for steady workloads requiring reliable throughput and latency."
                        ],
                        [
                          "P10",
                          "Popular choice for general-purpose production workloads with scalable performance."
                        ],
                        [
                          "P15",
                          "High IOPS tier for demanding apps with frequent read/write operations."
                        ],
                        [
                          "P20",
                          "Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads."
                        ],
                        [
                          "P30",
                          "Balanced tier for moderate throughput and latency-sensitive applications."
                        ],
                        [
                          "P40",
                          "Enhanced performance for growing production workloads with consistent IOPS demands."
                        ],
                        [
                          "P50",
                          "Optimized for enterprise-grade applications needing sustained high throughput."
                        ],
                        [
                          "P60",
                          "High-capacity tier for large databases and analytics workloads with elevated IOPS."
                        ],
                        [
                          "P70",
                          "Designed for mission-critical systems requiring ultra-low latency and high concurrency."
                        ],
                        [
                          "P80",
                          "Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads."
                        ]
                      ],
                      "old": [
                        [
                          "P1",
                          ""
                        ],
                        [
                          "P2",
                          ""
                        ],
                        [
                          "P3",
                          ""
                        ],
                        [
                          "P4",
                          ""
                        ],
                        [
                          "P6",
                          ""
                        ],
                        [
                          "P10",
                          ""
                        ],
                        [
                          "P15",
                          ""
                        ],
                        [
                          "P20",
                          ""
                        ],
                        [
                          "P30",
                          ""
                        ],
                        [
                          "P40",
                          ""
                        ],
                        [
                          "P50",
                          ""
                        ],
                        [
                          "P60",
                          ""
                        ],
                        [
                          "P70",
                          ""
                        ],
                        [
                          "P80",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "type",
                    "Enum": {
                      "new": [
                        [
                          "Premium_LRS",
                          "Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads."
                        ],
                        [
                          "PremiumV2_LRS",
                          "Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads."
                        ],
                        [
                          "UltraSSD_LRS",
                          "High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications."
                        ]
                      ],
                      "old": [
                        [
                          "Premium_LRS",
                          ""
                        ],
                        [
                          "PremiumV2_LRS",
                          ""
                        ],
                        [
                          "UltraSSD_LRS",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "authConfig": [
                  {
                    "#name": "activeDirectoryAuth",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Server supports Microsoft Entra authentication."
                        ],
                        [
                          "Disabled",
                          "Server doesn't support Microsoft Entra authentication."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "passwordAuth",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Server supports password based authentication."
                        ],
                        [
                          "Disabled",
                          "Server doesn't support password based authentication."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "dataEncryption": [
                  {
                    "#name": "type",
                    "Enum": {
                      "new": [
                        [
                          "SystemManaged",
                          "Encryption managed by Azure using platform managed keys for simplicity and compliance."
                        ],
                        [
                          "AzureKeyVault",
                          "Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security."
                        ]
                      ],
                      "old": [
                        [
                          "SystemManaged",
                          ""
                        ],
                        [
                          "AzureKeyVault",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "primaryEncryptionKeyStatus",
                    "Enum": {
                      "new": [
                        [
                          "Valid",
                          "Key is valid and can be used for encryption."
                        ],
                        [
                          "Invalid",
                          "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                        ]
                      ],
                      "old": [
                        [
                          "Valid",
                          ""
                        ],
                        [
                          "Invalid",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "geoBackupEncryptionKeyStatus",
                    "Enum": {
                      "new": [
                        [
                          "Valid",
                          "Key is valid and can be used for encryption."
                        ],
                        [
                          "Invalid",
                          "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                        ]
                      ],
                      "old": [
                        [
                          "Valid",
                          ""
                        ],
                        [
                          "Invalid",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "backup": [
                  {
                    "#name": "geoRedundantBackup",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Server is configured to create geographically redundant backups."
                        ],
                        [
                          "Disabled",
                          "Server is not configured to create geographically redundant backups."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "network": [
                  {
                    "#name": "publicNetworkAccess",
                    "Description": {
                      "new": "Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed.",
                      "old": "Indicates if public network access is enabled or not."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server."
                        ],
                        [
                          "Disabled",
                          "Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "highAvailability": [
                  {
                    "#name": "mode",
                    "Enum": {
                      "new": [
                        [
                          "Disabled",
                          "High availability is disabled for the server."
                        ],
                        [
                          "ZoneRedundant",
                          "High availability is enabled for the server, with standby server in a different availability zone than that of the primary."
                        ],
                        [
                          "SameZone",
                          "High availability is enabled for the server, with standby server in the same availability zone as the primary."
                        ]
                      ],
                      "old": [
                        [
                          "Disabled",
                          ""
                        ],
                        [
                          "ZoneRedundant",
                          ""
                        ],
                        [
                          "SameZone",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "state",
                    "Enum": {
                      "new": [
                        [
                          "NotEnabled",
                          "High availability is not enabled for the server."
                        ],
                        [
                          "CreatingStandby",
                          "Standby server is being created."
                        ],
                        [
                          "ReplicatingData",
                          "Data is being replicated to the standby server."
                        ],
                        [
                          "FailingOver",
                          "Failover operation to the standby server is in progress."
                        ],
                        [
                          "Healthy",
                          "Standby server is healthy and ready to take over in case of a failover."
                        ],
                        [
                          "RemovingStandby",
                          "Standby server is being removed."
                        ]
                      ],
                      "old": [
                        [
                          "NotEnabled",
                          ""
                        ],
                        [
                          "CreatingStandby",
                          ""
                        ],
                        [
                          "ReplicatingData",
                          ""
                        ],
                        [
                          "FailingOver",
                          ""
                        ],
                        [
                          "Healthy",
                          ""
                        ],
                        [
                          "RemovingStandby",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "replicationRole",
                "Enum": {
                  "new": [
                    [
                      "None",
                      "No replication role assigned; the server operates independently."
                    ],
                    [
                      "Primary",
                      "Acts as the source server for replication to one or more replicas."
                    ],
                    [
                      "AsyncReplica",
                      "Receives data asynchronously from a primary server within the same region."
                    ],
                    [
                      "GeoAsyncReplica",
                      "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "Primary",
                      ""
                    ],
                    [
                      "AsyncReplica",
                      ""
                    ],
                    [
                      "GeoAsyncReplica",
                      ""
                    ]
                  ]
                }
              },
              {
                "replica": [
                  {
                    "#name": "role",
                    "Enum": {
                      "new": [
                        [
                          "None",
                          "No replication role assigned; the server operates independently."
                        ],
                        [
                          "Primary",
                          "Acts as the source server for replication to one or more replicas."
                        ],
                        [
                          "AsyncReplica",
                          "Receives data asynchronously from a primary server within the same region."
                        ],
                        [
                          "GeoAsyncReplica",
                          "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                        ]
                      ],
                      "old": [
                        [
                          "None",
                          ""
                        ],
                        [
                          "Primary",
                          ""
                        ],
                        [
                          "AsyncReplica",
                          ""
                        ],
                        [
                          "GeoAsyncReplica",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "replicationState",
                    "Enum": {
                      "new": [
                        [
                          "Active",
                          "Read replica is fully synchronized and actively replicating data from the primary server."
                        ],
                        [
                          "Catchup",
                          "Read replica is behind the primary server and is currently catching up with pending changes."
                        ],
                        [
                          "Provisioning",
                          "Read replica is being created and is in process of getting initialized."
                        ],
                        [
                          "Updating",
                          "Read replica is undergoing some changes it can be changing compute size of promoting it to primary server."
                        ],
                        [
                          "Broken",
                          "Replication has failed or been interrupted."
                        ],
                        [
                          "Reconfiguring",
                          "Read replica is being reconfigured, possibly due to changes in source or settings."
                        ]
                      ],
                      "old": [
                        [
                          "Active",
                          "The read replica server is fully synchronized and actively replicating data from the primary server."
                        ],
                        [
                          "Catchup",
                          "The read replica server is behind the primary server and is currently catching up with pending changes."
                        ],
                        [
                          "Provisioning",
                          "The read replica server is being created and is in process of getting initialized."
                        ],
                        [
                          "Updating",
                          "The read replica server is undergoing some changes it can be changing compute size of promoting it to primary server."
                        ],
                        [
                          "Broken",
                          "Replication has failed or been interrupted."
                        ],
                        [
                          "Reconfiguring",
                          "The read replica server is being reconfigured, possibly due to changes in source or settings."
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "createMode",
                "Enum": {
                  "new": [
                    [
                      "Default",
                      "If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'."
                    ],
                    [
                      "Create",
                      "Operation creates a new server."
                    ],
                    [
                      "Update",
                      "Operation updates an existing server."
                    ],
                    [
                      "PointInTimeRestore",
                      "Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time."
                    ],
                    [
                      "GeoRestore",
                      "Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled."
                    ],
                    [
                      "Replica",
                      "Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary."
                    ],
                    [
                      "ReviveDropped",
                      "Operation creates a new server, initialized with the backup of a server that was recently deleted."
                    ]
                  ],
                  "old": [
                    [
                      "Default",
                      ""
                    ],
                    [
                      "Create",
                      ""
                    ],
                    [
                      "Update",
                      ""
                    ],
                    [
                      "PointInTimeRestore",
                      ""
                    ],
                    [
                      "GeoRestore",
                      ""
                    ],
                    [
                      "Replica",
                      ""
                    ],
                    [
                      "ReviveDropped",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 servers ,
Required: False ,
}
[
{
sku:
{
Description: Compute tier and size of a server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements. ,
GeneralPurpose: Balanced compute and memory for most workloads, offering scalable performance and I/O throughput. ,
MemoryOptimized: High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: Map of user assigned managed identities. ,
Required: False ,
}
object ,
principalId:
{
Description: Identifier of the object of the service principal associated to the user assigned managed identity. ,
Required: False ,
}
string ,
type:
{
Description: Types of identities associated with a server. ,
Enum:
{
None: No managed identity is assigned to the server. ,
UserAssigned: One or more managed identities provided by the user are assigned to the server. ,
SystemAssigned: Azure automatically creates and manages the identity associated to the lifecycle of the server. ,
SystemAssigned,UserAssigned: Both system-assigned and user-assigned identities are assigned to the server. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a server. ,
Required: False ,
}
{
administratorLogin:
{
Description: Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Enum:
{
17: PostgreSQL 17. ,
16: PostgreSQL 16. ,
15: PostgreSQL 15. ,
14: PostgreSQL 14. ,
13: PostgreSQL 13. ,
12: PostgreSQL 12. ,
11: PostgreSQL 11. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a server. ,
Enum:
{
Ready: Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level. ,
Dropping: Server is being deleted. ,
Disabled: Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription. ,
Starting: PostgreSQL database engine is being restarted. ,
Stopping: Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated. ,
Stopped: Compute resources associated with the server are being stopped and deallocated. ,
Updating: Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine. ,
Restarting: PostgreSQL database engine is being restarted. ,
Inaccessible: Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state. ,
Provisioning: Server is in the process of being created. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size. ,
Disabled: Server should not automatically grow storage size when available space is nearing zero. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a server. ,
Enum:
{
P1: Entry-level SSD for minimal IOPS, ideal for light development or testing workloads. ,
P2: Slightly higher IOPS for small-scale applications needing consistent low latency. ,
P3: Balanced performance for basic production workloads with moderate throughput. ,
P4: Enhanced IOPS for growing apps with predictable performance needs. ,
P6: Mid-tier SSD for steady workloads requiring reliable throughput and latency. ,
P10: Popular choice for general-purpose production workloads with scalable performance. ,
P15: High IOPS tier for demanding apps with frequent read/write operations. ,
P20: Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads. ,
P30: Balanced tier for moderate throughput and latency-sensitive applications. ,
P40: Enhanced performance for growing production workloads with consistent IOPS demands. ,
P50: Optimized for enterprise-grade applications needing sustained high throughput. ,
P60: High-capacity tier for large databases and analytics workloads with elevated IOPS. ,
P70: Designed for mission-critical systems requiring ultra-low latency and high concurrency. ,
P80: Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads. ,
PremiumV2_LRS: Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads. ,
UltraSSD_LRS: High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: Server supports Microsoft Entra authentication. ,
Disabled: Server doesn't support Microsoft Entra authentication. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: Server supports password based authentication. ,
Disabled: Server doesn't support password based authentication. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a server. ,
Enum:
{
SystemManaged: Encryption managed by Azure using platform managed keys for simplicity and compliance. ,
AzureKeyVault: Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
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: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: Server is configured to create geographically redundant backups. ,
Disabled: Server is not configured to create geographically redundant backups. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. ,
Enum:
{
Enabled: Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server. ,
Disabled: Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: High availability is disabled for the server. ,
ZoneRedundant: High availability is enabled for the server, with standby server in a different availability zone than that of the primary. ,
SameZone: High availability is enabled for the server, with standby server in the same availability zone as the primary. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: High availability is not enabled for the server. ,
CreatingStandby: Standby server is being created. ,
ReplicatingData: Data is being replicated to the standby server. ,
FailingOver: Failover operation to the standby server is in progress. ,
Healthy: Standby server is healthy and ready to take over in case of a failover. ,
RemovingStandby: Standby server is being removed. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. ,
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 to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: Identifier of the server to be used as the source of the new server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a server. Required only in case that you want to promote a server. ,
Required: False ,
}
{
role:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: Read replica is fully synchronized and actively replicating data from the primary server. ,
Catchup: Read replica is behind the primary server and is currently catching up with pending changes. ,
Provisioning: Read replica is being created and is in process of getting initialized. ,
Updating: Read replica is undergoing some changes it can be changing compute size of promoting it to primary server. ,
Broken: Replication has failed or been interrupted. ,
Reconfiguring: Read replica is being reconfigured, possibly due to changes in source or settings. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server. ,
Enum:
{
Standalone: Read replica will become an independent server. ,
Switchover: Read replica will swap roles with primary server. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only. ,
Enum:
{
Planned: The operation will wait for data in the read replica to be fully synchronized with its source server, before it initiates the operation. ,
Forced: The operation will not wait for data in the read replica to be synchronized with its source server, before it initiates the operation. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new server. ,
Enum:
{
Default: If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'. ,
Create: Operation creates a new server. ,
Update: Operation updates an existing server. ,
PointInTimeRestore: Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time. ,
GeoRestore: Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled. ,
Replica: Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary. ,
ReviveDropped: Operation creates a new server, initialized with the backup of a server that was recently deleted. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified server. ,
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: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDatabaseName:
{
Description: Default database name for the elastic cluster. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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 ,
}
,
]
,
}
,
}
Servers_ListBySubscription (updated)
Description :  Lists all servers in a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "sku": [
              {
                "#name": "tier",
                "Enum": {
                  "new": [
                    [
                      "Burstable",
                      "Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements."
                    ],
                    [
                      "GeneralPurpose",
                      "Balanced compute and memory for most workloads, offering scalable performance and I/O throughput."
                    ],
                    [
                      "MemoryOptimized",
                      "High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency."
                    ]
                  ],
                  "old": [
                    [
                      "Burstable",
                      ""
                    ],
                    [
                      "GeneralPurpose",
                      ""
                    ],
                    [
                      "MemoryOptimized",
                      ""
                    ]
                  ]
                }
              }
            ],
            "identity": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "None",
                      "No managed identity is assigned to the server."
                    ],
                    [
                      "UserAssigned",
                      "One or more managed identities provided by the user are assigned to the server."
                    ],
                    [
                      "SystemAssigned",
                      "Azure automatically creates and manages the identity associated to the lifecycle of the server."
                    ],
                    [
                      "SystemAssigned,UserAssigned",
                      "Both system-assigned and user-assigned identities are assigned to the server."
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "UserAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned",
                      ""
                    ],
                    [
                      "SystemAssigned,UserAssigned",
                      ""
                    ]
                  ]
                }
              }
            ],
            "properties": [
              {
                "#name": "version",
                "Enum": {
                  "new": [
                    [
                      "17",
                      "PostgreSQL 17."
                    ],
                    [
                      "16",
                      "PostgreSQL 16."
                    ],
                    [
                      "15",
                      "PostgreSQL 15."
                    ],
                    [
                      "14",
                      "PostgreSQL 14."
                    ],
                    [
                      "13",
                      "PostgreSQL 13."
                    ],
                    [
                      "12",
                      "PostgreSQL 12."
                    ],
                    [
                      "11",
                      "PostgreSQL 11."
                    ]
                  ],
                  "old": [
                    [
                      "17",
                      ""
                    ],
                    [
                      "16",
                      ""
                    ],
                    [
                      "15",
                      ""
                    ],
                    [
                      "14",
                      ""
                    ],
                    [
                      "13",
                      ""
                    ],
                    [
                      "12",
                      ""
                    ],
                    [
                      "11",
                      ""
                    ]
                  ]
                }
              },
              {
                "#name": "state",
                "Enum": {
                  "new": [
                    [
                      "Ready",
                      "Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level."
                    ],
                    [
                      "Dropping",
                      "Server is being deleted."
                    ],
                    [
                      "Disabled",
                      "Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription."
                    ],
                    [
                      "Starting",
                      "PostgreSQL database engine is being restarted."
                    ],
                    [
                      "Stopping",
                      "Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated."
                    ],
                    [
                      "Stopped",
                      "Compute resources associated with the server are being stopped and deallocated."
                    ],
                    [
                      "Updating",
                      "Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine."
                    ],
                    [
                      "Restarting",
                      "PostgreSQL database engine is being restarted."
                    ],
                    [
                      "Inaccessible",
                      "Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state."
                    ],
                    [
                      "Provisioning",
                      "Server is in the process of being created."
                    ]
                  ],
                  "old": [
                    [
                      "Ready",
                      ""
                    ],
                    [
                      "Dropping",
                      ""
                    ],
                    [
                      "Disabled",
                      ""
                    ],
                    [
                      "Starting",
                      ""
                    ],
                    [
                      "Stopping",
                      ""
                    ],
                    [
                      "Stopped",
                      ""
                    ],
                    [
                      "Updating",
                      ""
                    ],
                    [
                      "Restarting",
                      ""
                    ],
                    [
                      "Inaccessible",
                      ""
                    ],
                    [
                      "Provisioning",
                      ""
                    ]
                  ]
                }
              },
              {
                "storage": [
                  {
                    "#name": "autoGrow",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size."
                        ],
                        [
                          "Disabled",
                          "Server should not automatically grow storage size when available space is nearing zero."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "tier",
                    "Enum": {
                      "new": [
                        [
                          "P1",
                          "Entry-level SSD for minimal IOPS, ideal for light development or testing workloads."
                        ],
                        [
                          "P2",
                          "Slightly higher IOPS for small-scale applications needing consistent low latency."
                        ],
                        [
                          "P3",
                          "Balanced performance for basic production workloads with moderate throughput."
                        ],
                        [
                          "P4",
                          "Enhanced IOPS for growing apps with predictable performance needs."
                        ],
                        [
                          "P6",
                          "Mid-tier SSD for steady workloads requiring reliable throughput and latency."
                        ],
                        [
                          "P10",
                          "Popular choice for general-purpose production workloads with scalable performance."
                        ],
                        [
                          "P15",
                          "High IOPS tier for demanding apps with frequent read/write operations."
                        ],
                        [
                          "P20",
                          "Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads."
                        ],
                        [
                          "P30",
                          "Balanced tier for moderate throughput and latency-sensitive applications."
                        ],
                        [
                          "P40",
                          "Enhanced performance for growing production workloads with consistent IOPS demands."
                        ],
                        [
                          "P50",
                          "Optimized for enterprise-grade applications needing sustained high throughput."
                        ],
                        [
                          "P60",
                          "High-capacity tier for large databases and analytics workloads with elevated IOPS."
                        ],
                        [
                          "P70",
                          "Designed for mission-critical systems requiring ultra-low latency and high concurrency."
                        ],
                        [
                          "P80",
                          "Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads."
                        ]
                      ],
                      "old": [
                        [
                          "P1",
                          ""
                        ],
                        [
                          "P2",
                          ""
                        ],
                        [
                          "P3",
                          ""
                        ],
                        [
                          "P4",
                          ""
                        ],
                        [
                          "P6",
                          ""
                        ],
                        [
                          "P10",
                          ""
                        ],
                        [
                          "P15",
                          ""
                        ],
                        [
                          "P20",
                          ""
                        ],
                        [
                          "P30",
                          ""
                        ],
                        [
                          "P40",
                          ""
                        ],
                        [
                          "P50",
                          ""
                        ],
                        [
                          "P60",
                          ""
                        ],
                        [
                          "P70",
                          ""
                        ],
                        [
                          "P80",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "type",
                    "Enum": {
                      "new": [
                        [
                          "Premium_LRS",
                          "Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads."
                        ],
                        [
                          "PremiumV2_LRS",
                          "Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads."
                        ],
                        [
                          "UltraSSD_LRS",
                          "High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications."
                        ]
                      ],
                      "old": [
                        [
                          "Premium_LRS",
                          ""
                        ],
                        [
                          "PremiumV2_LRS",
                          ""
                        ],
                        [
                          "UltraSSD_LRS",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "authConfig": [
                  {
                    "#name": "activeDirectoryAuth",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Server supports Microsoft Entra authentication."
                        ],
                        [
                          "Disabled",
                          "Server doesn't support Microsoft Entra authentication."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "passwordAuth",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Server supports password based authentication."
                        ],
                        [
                          "Disabled",
                          "Server doesn't support password based authentication."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "dataEncryption": [
                  {
                    "#name": "type",
                    "Enum": {
                      "new": [
                        [
                          "SystemManaged",
                          "Encryption managed by Azure using platform managed keys for simplicity and compliance."
                        ],
                        [
                          "AzureKeyVault",
                          "Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security."
                        ]
                      ],
                      "old": [
                        [
                          "SystemManaged",
                          ""
                        ],
                        [
                          "AzureKeyVault",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "primaryEncryptionKeyStatus",
                    "Enum": {
                      "new": [
                        [
                          "Valid",
                          "Key is valid and can be used for encryption."
                        ],
                        [
                          "Invalid",
                          "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                        ]
                      ],
                      "old": [
                        [
                          "Valid",
                          ""
                        ],
                        [
                          "Invalid",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "geoBackupEncryptionKeyStatus",
                    "Enum": {
                      "new": [
                        [
                          "Valid",
                          "Key is valid and can be used for encryption."
                        ],
                        [
                          "Invalid",
                          "Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key."
                        ]
                      ],
                      "old": [
                        [
                          "Valid",
                          ""
                        ],
                        [
                          "Invalid",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "backup": [
                  {
                    "#name": "geoRedundantBackup",
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Server is configured to create geographically redundant backups."
                        ],
                        [
                          "Disabled",
                          "Server is not configured to create geographically redundant backups."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "network": [
                  {
                    "#name": "publicNetworkAccess",
                    "Description": {
                      "new": "Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed.",
                      "old": "Indicates if public network access is enabled or not."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Enabled",
                          "Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server."
                        ],
                        [
                          "Disabled",
                          "Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints."
                        ]
                      ],
                      "old": [
                        [
                          "Enabled",
                          ""
                        ],
                        [
                          "Disabled",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "highAvailability": [
                  {
                    "#name": "mode",
                    "Enum": {
                      "new": [
                        [
                          "Disabled",
                          "High availability is disabled for the server."
                        ],
                        [
                          "ZoneRedundant",
                          "High availability is enabled for the server, with standby server in a different availability zone than that of the primary."
                        ],
                        [
                          "SameZone",
                          "High availability is enabled for the server, with standby server in the same availability zone as the primary."
                        ]
                      ],
                      "old": [
                        [
                          "Disabled",
                          ""
                        ],
                        [
                          "ZoneRedundant",
                          ""
                        ],
                        [
                          "SameZone",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "state",
                    "Enum": {
                      "new": [
                        [
                          "NotEnabled",
                          "High availability is not enabled for the server."
                        ],
                        [
                          "CreatingStandby",
                          "Standby server is being created."
                        ],
                        [
                          "ReplicatingData",
                          "Data is being replicated to the standby server."
                        ],
                        [
                          "FailingOver",
                          "Failover operation to the standby server is in progress."
                        ],
                        [
                          "Healthy",
                          "Standby server is healthy and ready to take over in case of a failover."
                        ],
                        [
                          "RemovingStandby",
                          "Standby server is being removed."
                        ]
                      ],
                      "old": [
                        [
                          "NotEnabled",
                          ""
                        ],
                        [
                          "CreatingStandby",
                          ""
                        ],
                        [
                          "ReplicatingData",
                          ""
                        ],
                        [
                          "FailingOver",
                          ""
                        ],
                        [
                          "Healthy",
                          ""
                        ],
                        [
                          "RemovingStandby",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "replicationRole",
                "Enum": {
                  "new": [
                    [
                      "None",
                      "No replication role assigned; the server operates independently."
                    ],
                    [
                      "Primary",
                      "Acts as the source server for replication to one or more replicas."
                    ],
                    [
                      "AsyncReplica",
                      "Receives data asynchronously from a primary server within the same region."
                    ],
                    [
                      "GeoAsyncReplica",
                      "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      ""
                    ],
                    [
                      "Primary",
                      ""
                    ],
                    [
                      "AsyncReplica",
                      ""
                    ],
                    [
                      "GeoAsyncReplica",
                      ""
                    ]
                  ]
                }
              },
              {
                "replica": [
                  {
                    "#name": "role",
                    "Enum": {
                      "new": [
                        [
                          "None",
                          "No replication role assigned; the server operates independently."
                        ],
                        [
                          "Primary",
                          "Acts as the source server for replication to one or more replicas."
                        ],
                        [
                          "AsyncReplica",
                          "Receives data asynchronously from a primary server within the same region."
                        ],
                        [
                          "GeoAsyncReplica",
                          "Receives data asynchronously from a primary server in a different region for geographical redundancy."
                        ]
                      ],
                      "old": [
                        [
                          "None",
                          ""
                        ],
                        [
                          "Primary",
                          ""
                        ],
                        [
                          "AsyncReplica",
                          ""
                        ],
                        [
                          "GeoAsyncReplica",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "replicationState",
                    "Enum": {
                      "new": [
                        [
                          "Active",
                          "Read replica is fully synchronized and actively replicating data from the primary server."
                        ],
                        [
                          "Catchup",
                          "Read replica is behind the primary server and is currently catching up with pending changes."
                        ],
                        [
                          "Provisioning",
                          "Read replica is being created and is in process of getting initialized."
                        ],
                        [
                          "Updating",
                          "Read replica is undergoing some changes it can be changing compute size of promoting it to primary server."
                        ],
                        [
                          "Broken",
                          "Replication has failed or been interrupted."
                        ],
                        [
                          "Reconfiguring",
                          "Read replica is being reconfigured, possibly due to changes in source or settings."
                        ]
                      ],
                      "old": [
                        [
                          "Active",
                          "The read replica server is fully synchronized and actively replicating data from the primary server."
                        ],
                        [
                          "Catchup",
                          "The read replica server is behind the primary server and is currently catching up with pending changes."
                        ],
                        [
                          "Provisioning",
                          "The read replica server is being created and is in process of getting initialized."
                        ],
                        [
                          "Updating",
                          "The read replica server is undergoing some changes it can be changing compute size of promoting it to primary server."
                        ],
                        [
                          "Broken",
                          "Replication has failed or been interrupted."
                        ],
                        [
                          "Reconfiguring",
                          "The read replica server is being reconfigured, possibly due to changes in source or settings."
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "createMode",
                "Enum": {
                  "new": [
                    [
                      "Default",
                      "If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'."
                    ],
                    [
                      "Create",
                      "Operation creates a new server."
                    ],
                    [
                      "Update",
                      "Operation updates an existing server."
                    ],
                    [
                      "PointInTimeRestore",
                      "Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time."
                    ],
                    [
                      "GeoRestore",
                      "Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled."
                    ],
                    [
                      "Replica",
                      "Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary."
                    ],
                    [
                      "ReviveDropped",
                      "Operation creates a new server, initialized with the backup of a server that was recently deleted."
                    ]
                  ],
                  "old": [
                    [
                      "Default",
                      ""
                    ],
                    [
                      "Create",
                      ""
                    ],
                    [
                      "Update",
                      ""
                    ],
                    [
                      "PointInTimeRestore",
                      ""
                    ],
                    [
                      "GeoRestore",
                      ""
                    ],
                    [
                      "Replica",
                      ""
                    ],
                    [
                      "ReviveDropped",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 servers ,
Required: False ,
}
[
{
sku:
{
Description: Compute tier and size of a server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a server. ,
Enum:
{
Burstable: Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements. ,
GeneralPurpose: Balanced compute and memory for most workloads, offering scalable performance and I/O throughput. ,
MemoryOptimized: High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: Map of user assigned managed identities. ,
Required: False ,
}
object ,
principalId:
{
Description: Identifier of the object of the service principal associated to the user assigned managed identity. ,
Required: False ,
}
string ,
type:
{
Description: Types of identities associated with a server. ,
Enum:
{
None: No managed identity is assigned to the server. ,
UserAssigned: One or more managed identities provided by the user are assigned to the server. ,
SystemAssigned: Azure automatically creates and manages the identity associated to the lifecycle of the server. ,
SystemAssigned,UserAssigned: Both system-assigned and user-assigned identities are assigned to the server. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a server. ,
Required: False ,
}
{
administratorLogin:
{
Description: Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. ,
Format: password ,
Required: False ,
}
string ,
version:
{
Description: Major version of PostgreSQL database engine. ,
Enum:
{
17: PostgreSQL 17. ,
16: PostgreSQL 16. ,
15: PostgreSQL 15. ,
14: PostgreSQL 14. ,
13: PostgreSQL 13. ,
12: PostgreSQL 12. ,
11: PostgreSQL 11. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a server. ,
Enum:
{
Ready: Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level. ,
Dropping: Server is being deleted. ,
Disabled: Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription. ,
Starting: PostgreSQL database engine is being restarted. ,
Stopping: Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated. ,
Stopped: Compute resources associated with the server are being stopped and deallocated. ,
Updating: Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine. ,
Restarting: PostgreSQL database engine is being restarted. ,
Inaccessible: Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state. ,
Provisioning: Server is in the process of being created. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size. ,
Disabled: Server should not automatically grow storage size when available space is nearing zero. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a server. ,
Enum:
{
P1: Entry-level SSD for minimal IOPS, ideal for light development or testing workloads. ,
P2: Slightly higher IOPS for small-scale applications needing consistent low latency. ,
P3: Balanced performance for basic production workloads with moderate throughput. ,
P4: Enhanced IOPS for growing apps with predictable performance needs. ,
P6: Mid-tier SSD for steady workloads requiring reliable throughput and latency. ,
P10: Popular choice for general-purpose production workloads with scalable performance. ,
P15: High IOPS tier for demanding apps with frequent read/write operations. ,
P20: Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads. ,
P30: Balanced tier for moderate throughput and latency-sensitive applications. ,
P40: Enhanced performance for growing production workloads with consistent IOPS demands. ,
P50: Optimized for enterprise-grade applications needing sustained high throughput. ,
P60: High-capacity tier for large databases and analytics workloads with elevated IOPS. ,
P70: Designed for mission-critical systems requiring ultra-low latency and high concurrency. ,
P80: Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
throughput:
{
Description: Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads. ,
PremiumV2_LRS: Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads. ,
UltraSSD_LRS: High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: Server supports Microsoft Entra authentication. ,
Disabled: Server doesn't support Microsoft Entra authentication. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: Server supports password based authentication. ,
Disabled: Server doesn't support password based authentication. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. ,
Required: False ,
}
string ,
geoBackupKeyURI:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
geoBackupUserAssignedIdentityId:
{
Description: Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a server. ,
Enum:
{
SystemManaged: Encryption managed by Azure using platform managed keys for simplicity and compliance. ,
AzureKeyVault: Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: Key is valid and can be used for encryption. ,
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key. ,
}
,
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: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: Server is configured to create geographically redundant backups. ,
Disabled: Server is not configured to create geographically redundant backups. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. ,
Enum:
{
Enabled: Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server. ,
Disabled: Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints. ,
}
,
Required: False ,
}
enum ,
delegatedSubnetResourceId:
{
Description: Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
privateDnsZoneArmResourceId:
{
Description: Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a server. ,
Enum:
{
Disabled: High availability is disabled for the server. ,
ZoneRedundant: High availability is enabled for the server, with standby server in a different availability zone than that of the primary. ,
SameZone: High availability is enabled for the server, with standby server in the same availability zone as the primary. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: High availability is not enabled for the server. ,
CreatingStandby: Standby server is being created. ,
ReplicatingData: Data is being replicated to the standby server. ,
FailingOver: Failover operation to the standby server is in progress. ,
Healthy: Standby server is healthy and ready to take over in case of a failover. ,
RemovingStandby: Standby server is being removed. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. ,
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 to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week to be used for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceServerResourceId:
{
Description: Identifier of the server to be used as the source of the new server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a server. Required only in case that you want to promote a server. ,
Required: False ,
}
{
role:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No replication role assigned; the server operates independently. ,
Primary: Acts as the source server for replication to one or more replicas. ,
AsyncReplica: Receives data asynchronously from a primary server within the same region. ,
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: Read replica is fully synchronized and actively replicating data from the primary server. ,
Catchup: Read replica is behind the primary server and is currently catching up with pending changes. ,
Provisioning: Read replica is being created and is in process of getting initialized. ,
Updating: Read replica is undergoing some changes it can be changing compute size of promoting it to primary server. ,
Broken: Replication has failed or been interrupted. ,
Reconfiguring: Read replica is being reconfigured, possibly due to changes in source or settings. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server. ,
Enum:
{
Standalone: Read replica will become an independent server. ,
Switchover: Read replica will swap roles with primary server. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only. ,
Enum:
{
Planned: The operation will wait for data in the read replica to be fully synchronized with its source server, before it initiates the operation. ,
Forced: The operation will not wait for data in the read replica to be synchronized with its source server, before it initiates the operation. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new server. ,
Enum:
{
Default: If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'. ,
Create: Operation creates a new server. ,
Update: Operation updates an existing server. ,
PointInTimeRestore: Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time. ,
GeoRestore: Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled. ,
Replica: Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary. ,
ReviveDropped: Operation creates a new server, initialized with the backup of a server that was recently deleted. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified server. ,
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: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDatabaseName:
{
Description: Default database name for the elastic cluster. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
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 ,
}
,
]
,
}
,
}
Servers_Restart (updated)
Description :  Restarts PostgreSQL database engine in a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Restart",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "failoverMode",
          "Enum": {
            "new": [
              [
                "PlannedFailover",
                "Triggers a failover from primary to standby without killing the primary database process first. This is a graceful failover that attempts to preserve data consistency."
              ],
              [
                "ForcedFailover",
                "Kills the primary database process first, then triggers the failover. This is more aggressive and used when the primary is unresponsive or in an unhealthy state."
              ],
              [
                "PlannedSwitchover",
                "Similar to 'PlannedFailover' but prefers a switch over operation where roles are swapped between primary and standby."
              ],
              [
                "ForcedSwitchover",
                "Kills the primary database process and then triggers a switch over with role swapping."
              ]
            ],
            "old": [
              [
                "PlannedFailover",
                ""
              ],
              [
                "ForcedFailover",
                ""
              ],
              [
                "PlannedSwitchover",
                ""
              ],
              [
                "ForcedSwitchover",
                ""
              ]
            ]
          }
        }
      ]
    }
  }
}

⚼ 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: Parameters to restart a server. ,
Required: False ,
}
{
restartWithFailover:
{
Description: Indicates if restart the PostgreSQL database engine should failover or switch over from primary to standby. This only works if server has high availability enabled. ,
Required: False ,
}
boolean ,
failoverMode:
{
Description: Failover mode. ,
Enum:
{
PlannedFailover: Triggers a failover from primary to standby without killing the primary database process first. This is a graceful failover that attempts to preserve data consistency. ,
ForcedFailover: Kills the primary database process first, then triggers the failover. This is more aggressive and used when the primary is unresponsive or in an unhealthy state. ,
PlannedSwitchover: Similar to 'PlannedFailover' but prefers a switch over operation where roles are swapped between primary and standby. ,
ForcedSwitchover: Kills the primary database process and then triggers a switch over with role swapping. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: 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 (updated)
Description :  Updates a pair of virtual endpoints for a server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualEndpoints_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "endpointType",
            "Enum": {
              "new": [
                [
                  "ReadWrite",
                  "Read-write endpoint."
                ]
              ],
              "old": [
                [
                  "ReadWrite",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Base name of the virtual endpoints. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to update a pair of virtual endpoints. ,
Required: True ,
}
{
properties:
{
Description: Properties of the pair of virtual endpoints. ,
Required: False ,
}
{
endpointType:
{
Description: Type of endpoint for the virtual endpoints. ,
Enum:
{
ReadWrite: Read-write endpoint. ,
}
,
Required: False ,
}
enum ,
members:
{
Description: List of servers that one of the virtual endpoints can refer to. ,
Required: False ,
}
[
string ,
]
,
virtualEndpoints:
{
Description: List of virtual endpoints for a server. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: 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 ,
}
,
]
,
}
,
}