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

2025/05/27 • 64 updated methods

Administrators_Create (updated)
Description :  Creates a new server administrator associated to a Microsoft Entra principal.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Administrators_Create",
  "Description": {
    "new": "Creates a new server administrator associated to a Microsoft Entra principal.",
    "old": "Creates a new server."
  },
  "$parameters": [
    {
      "#name": "objectId",
      "Description": {
        "new": "Object identifier of the Microsoft Entra principal.",
        "old": "Guid of the objectId for the administrator."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Required parameters for adding a server administrator associated to a Microsoft Entra principal.",
        "old": "The required parameters for adding an Microsoft Entra Administrator for a server."
      },
      "$schema": {
        "Description": {
          "new": "Server administrator associated to a Microsoft Entra principal.",
          "old": "Represents an Microsoft Entra Administrator."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Properties of the server administrator associated to a Microsoft Entra principal.",
              "old": "Properties of the Microsoft Entra Administrator."
            },
            "$properties": [
              {
                "#name": "principalType",
                "Description": {
                  "new": "The type of Microsoft Entra principal to which the server administrator is associated.",
                  "old": "The principal type used to represent the type of Microsoft Entra Administrator."
                }
              },
              {
                "#name": "principalName",
                "Description": {
                  "new": "Name of the Microsoft Entra principal.",
                  "old": "Microsoft Entra Administrator principal name."
                }
              },
              {
                "#name": "tenantId",
                "Description": {
                  "new": "Identifier of the tenant in which the Microsoft Entra principal exists.",
                  "old": "The tenantId of the Microsoft Entra Administrator."
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Server administrator associated to a Microsoft Entra principal.",
        "old": "Represents an Microsoft Entra Administrator."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a server administrator associated to a Microsoft Entra principal.",
            "old": "Properties of the Microsoft Entra Administrator."
          },
          "$properties": [
            {
              "#name": "principalType",
              "Description": {
                "new": "Type of Microsoft Entra principal to which the server administrator is associated.",
                "old": "The principal type used to represent the type of Microsoft Entra Administrator."
              }
            },
            {
              "#name": "principalName",
              "Description": {
                "new": "Name of the Microsoft Entra principal.",
                "old": "Microsoft Entra Administrator principal name."
              }
            },
            {
              "#name": "objectId",
              "Description": {
                "new": "Object identifier of the Microsoft Entra principal.",
                "old": "The objectId of the Microsoft Entra Administrator."
              }
            },
            {
              "#name": "tenantId",
              "Description": {
                "new": "Identifier of the tenant in which the Microsoft Entra principal exists.",
                "old": "The tenantId of the Microsoft Entra Administrator."
              }
            }
          ]
        }
      ]
    },
    "201": {
      "Description": {
        "new": "Server administrator associated to a Microsoft Entra principal.",
        "old": "Represents an Microsoft Entra Administrator."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a server administrator associated to a Microsoft Entra principal.",
            "old": "Properties of the Microsoft Entra Administrator."
          },
          "$properties": [
            {
              "#name": "principalType",
              "Description": {
                "new": "Type of Microsoft Entra principal to which the server administrator is associated.",
                "old": "The principal type used to represent the type of Microsoft Entra Administrator."
              }
            },
            {
              "#name": "principalName",
              "Description": {
                "new": "Name of the Microsoft Entra principal.",
                "old": "Microsoft Entra Administrator principal name."
              }
            },
            {
              "#name": "objectId",
              "Description": {
                "new": "Object identifier of the Microsoft Entra principal.",
                "old": "The objectId of the Microsoft Entra Administrator."
              }
            },
            {
              "#name": "tenantId",
              "Description": {
                "new": "Identifier of the tenant in which the Microsoft Entra principal exists.",
                "old": "The tenantId of the Microsoft Entra Administrator."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
objectId:
{
Description: Object identifier of the Microsoft Entra principal. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Required parameters for adding a server administrator associated to a Microsoft Entra principal. ,
Required: True ,
}
{
properties:
{
Description: Properties of the server administrator associated to a Microsoft Entra principal. ,
Required: False ,
}
{
principalType:
{
Description: The type of Microsoft Entra principal to which the server administrator is associated. ,
Enum:
{
Unknown: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: False ,
}
enum ,
principalName:
{
Description: Name 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 (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: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
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 (201)

{
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: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
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 (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Administrators_Delete (updated)
Description :  Deletes an existing server administrator associated to a Microsoft Entra principal.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Administrators_Delete",
  "Description": {
    "new": "Deletes an existing server administrator associated to a Microsoft Entra principal.",
    "old": "Deletes an Microsoft Entra Administrator associated with the server."
  },
  "$parameters": [
    {
      "#name": "objectId",
      "Description": {
        "new": "Object identifier of the Microsoft Entra principal.",
        "old": "Guid of the objectId for the administrator."
      }
    }
  ]
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Administrators_Get",
  "Description": {
    "new": "Gets information about a server administrator associated to a Microsoft Entra principal.",
    "old": "Gets information about a server."
  },
  "$parameters": [
    {
      "#name": "objectId",
      "Description": {
        "new": "Object identifier of the Microsoft Entra principal.",
        "old": "Guid of the objectId for the administrator."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Server administrator associated to a Microsoft Entra principal.",
        "old": "Represents an Microsoft Entra Administrator."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a server administrator associated to a Microsoft Entra principal.",
            "old": "Properties of the Microsoft Entra Administrator."
          },
          "$properties": [
            {
              "#name": "principalType",
              "Description": {
                "new": "Type of Microsoft Entra principal to which the server administrator is associated.",
                "old": "The principal type used to represent the type of Microsoft Entra Administrator."
              }
            },
            {
              "#name": "principalName",
              "Description": {
                "new": "Name of the Microsoft Entra principal.",
                "old": "Microsoft Entra Administrator principal name."
              }
            },
            {
              "#name": "objectId",
              "Description": {
                "new": "Object identifier of the Microsoft Entra principal.",
                "old": "The objectId of the Microsoft Entra Administrator."
              }
            },
            {
              "#name": "tenantId",
              "Description": {
                "new": "Identifier of the tenant in which the Microsoft Entra principal exists.",
                "old": "The tenantId of the Microsoft Entra Administrator."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ 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: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
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 ,
}
,
]
,
}
,
}
Administrators_ListByServer (updated)
Description :  List all server administrators associated to a Microsoft Entra principal.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Administrators_ListByServer",
  "Description": {
    "new": "List all server administrators associated to a Microsoft Entra principal.",
    "old": "List all the AAD administrators for a given server."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of server administrators associated to Microsoft Entra principals.",
        "old": "A list of Microsoft Entra Administrators."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of server administrators associated to Microsoft Entra principals.",
            "old": "The list of Microsoft Entra Administrators"
          },
          "$items": {
            "Description": {
              "new": "Server administrator associated to a Microsoft Entra principal.",
              "old": "Represents an Microsoft Entra Administrator."
            },
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Properties of a server administrator associated to a Microsoft Entra principal.",
                  "old": "Properties of the Microsoft Entra Administrator."
                },
                "$properties": [
                  {
                    "#name": "principalType",
                    "Description": {
                      "new": "Type of Microsoft Entra principal to which the server administrator is associated.",
                      "old": "The principal type used to represent the type of Microsoft Entra Administrator."
                    }
                  },
                  {
                    "#name": "principalName",
                    "Description": {
                      "new": "Name of the Microsoft Entra principal.",
                      "old": "Microsoft Entra Administrator principal name."
                    }
                  },
                  {
                    "#name": "objectId",
                    "Description": {
                      "new": "Object identifier of the Microsoft Entra principal.",
                      "old": "The objectId of the Microsoft Entra Administrator."
                    }
                  },
                  {
                    "#name": "tenantId",
                    "Description": {
                      "new": "Identifier of the tenant in which the Microsoft Entra principal exists.",
                      "old": "The tenantId of the Microsoft Entra Administrator."
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "The link used to get the next page of Microsoft Entra administrators."
          }
        }
      ]
    }
  }
}

⚼ 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: No description available. ,
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
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. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backups_Create (updated)
Description :  Creates an on demand backup of a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_Create",
  "Description": {
    "new": "Creates an on demand backup of a flexible server.",
    "old": "Create a specific backup for PostgreSQL flexible server."
  },
  "$parameters": [
    {
      "#name": "backupName",
      "Description": {
        "new": "Name of the backup.",
        "old": "The name of the backup."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Properties of a backup.",
        "old": "Server backup properties"
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a backup.",
            "old": "The properties of a server backup."
          },
          "$properties": [
            {
              "#name": "backupType",
              "Description": {
                "new": "Type of backup.",
                "old": "Backup type."
              }
            },
            {
              "#name": "completedTime",
              "Description": {
                "new": "Time(ISO8601 format) at which the backup was completed.",
                "old": "Backup completed time (ISO8601 format)."
              }
            },
            {
              "#name": "source",
              "Description": {
                "new": "Source of the backup.",
                "old": "Backup source"
              }
            }
          ]
        }
      ]
    },
    "201": {
      "Description": {
        "new": "Properties of a backup.",
        "old": "Server backup properties"
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a backup.",
            "old": "The properties of a server backup."
          },
          "$properties": [
            {
              "#name": "backupType",
              "Description": {
                "new": "Type of backup.",
                "old": "Backup type."
              }
            },
            {
              "#name": "completedTime",
              "Description": {
                "new": "Time(ISO8601 format) at which the backup was completed.",
                "old": "Backup completed time (ISO8601 format)."
              }
            },
            {
              "#name": "source",
              "Description": {
                "new": "Source of the backup.",
                "old": "Backup source"
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Properties of a backup. ,
Required: False ,
}
{
backupType:
{
Description: Type of backup. ,
Enum:
{
Full: No description available. ,
Customer On-Demand: No description available. ,
}
,
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 (201)

{
properties:
{
Description: Properties of a backup. ,
Required: False ,
}
{
backupType:
{
Description: Type of backup. ,
Enum:
{
Full: No description available. ,
Customer On-Demand: No description available. ,
}
,
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 (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backups_Delete (updated)
Description :  Deletes a specific backup, given its name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_Delete",
  "Description": {
    "new": "Deletes a specific backup, given its name.",
    "old": "Deletes a specific backup."
  },
  "$parameters": [
    {
      "#name": "backupName",
      "Description": {
        "new": "Name of the backup.",
        "old": "The name of the backup."
      }
    }
  ]
}

⚼ Request

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backups_Get (updated)
Description :  Gets information of an on demand backup, given its name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_Get",
  "Description": {
    "new": "Gets information of an on demand backup, given its name.",
    "old": "Get specific backup for a given server."
  },
  "$parameters": [
    {
      "#name": "backupName",
      "Description": {
        "new": "Name of the backup.",
        "old": "The name of the backup."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Properties of a backup.",
        "old": "Server backup properties"
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a backup.",
            "old": "The properties of a server backup."
          },
          "$properties": [
            {
              "#name": "backupType",
              "Description": {
                "new": "Type of backup.",
                "old": "Backup type."
              }
            },
            {
              "#name": "completedTime",
              "Description": {
                "new": "Time(ISO8601 format) at which the backup was completed.",
                "old": "Backup completed time (ISO8601 format)."
              }
            },
            {
              "#name": "source",
              "Description": {
                "new": "Source of the backup.",
                "old": "Backup source"
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ 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: No description available. ,
Customer On-Demand: No description available. ,
}
,
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 ,
}
,
]
,
}
,
}
Backups_ListByServer (updated)
Description :  Lists all available backups of a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_ListByServer",
  "Description": {
    "new": "Lists all available backups of a flexible server.",
    "old": "List all the backups for a given server."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of backups.",
        "old": "A list of server backups."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of available backups.",
            "old": "The list of backups of a server."
          },
          "$items": {
            "Description": {
              "new": "Properties of a backup.",
              "old": "Server backup properties"
            },
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Properties of a backup.",
                  "old": "The properties of a server backup."
                },
                "$properties": [
                  {
                    "#name": "backupType",
                    "Description": {
                      "new": "Type of backup.",
                      "old": "Backup type."
                    }
                  },
                  {
                    "#name": "completedTime",
                    "Description": {
                      "new": "Time(ISO8601 format) at which the backup was completed.",
                      "old": "Backup completed time (ISO8601 format)."
                    }
                  },
                  {
                    "#name": "source",
                    "Description": {
                      "new": "Source of the backup.",
                      "old": "Backup source"
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "The link used to get the next page of operations."
          }
        }
      ]
    }
  }
}

⚼ 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: No description available. ,
Customer On-Demand: No description available. ,
}
,
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. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LocationBasedCapabilities_Execute (updated)
Description :  Lists the capabilities available in a given location for a specific subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LocationBasedCapabilities_Execute",
  "Description": {
    "new": "Lists the capabilities available in a given location for a specific subscription.",
    "old": "Get capabilities at specified location in a given subscription."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Capability for the Azure Database for PostgreSQL flexible server.",
        "old": "Capability for the PostgreSQL server"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of supported capabilities.",
            "old": "A list of supported capabilities."
          },
          "$items": {
            "Description": {
              "new": "Capability for the Azure Database for PostgreSQL flexible server.",
              "old": "Capability for the PostgreSQL server"
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name of flexible servers capabilities.",
                  "old": "Name of flexible servers capability"
                }
              },
              {
                "#name": "supportedServerEditions",
                "Description": {
                  "new": "List of supported compute tiers.",
                  "old": "List of supported flexible server editions"
                },
                "$items": {
                  "Description": {
                    "new": "Capabilities in terms of compute tier.",
                    "old": "Flexible server edition capabilities."
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Name of compute tier.",
                        "old": "Server edition name"
                      }
                    },
                    {
                      "#name": "defaultSkuName",
                      "Description": {
                        "new": "Default compute name (SKU) for this computer tier.",
                        "old": "Default sku name for the server edition"
                      }
                    },
                    {
                      "#name": "supportedStorageEditions",
                      "Description": {
                        "new": "List of storage editions supported by this compute tier and compute name.",
                        "old": "The list of editions supported by this server edition."
                      },
                      "$items": {
                        "Description": {
                          "new": "Capabilities in terms of storage tier.",
                          "old": "Storage edition capability"
                        },
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Name of storage tier.",
                              "old": "Storage edition name"
                            }
                          },
                          {
                            "#name": "defaultStorageSizeMb",
                            "Description": {
                              "new": "Default storage size (in MB) for this storage tier.",
                              "old": "Default storage size in MB for storage edition"
                            }
                          },
                          {
                            "#name": "supportedStorageMb",
                            "Description": {
                              "new": "Configurations of storage supported for this storage tier.",
                              "old": "Flexible server supported storage range in MB"
                            },
                            "$items": {
                              "Description": {
                                "new": "Storage size (in MB) capability.",
                                "old": "storage size in MB capability"
                              },
                              "$properties": [
                                {
                                  "#name": "supportedIops",
                                  "Description": {
                                    "new": "Minimum IOPS supported by the storage size.",
                                    "old": "Supported IOPS"
                                  }
                                },
                                {
                                  "#name": "supportedMaximumIops",
                                  "Description": {
                                    "new": "Maximum IOPS supported by the storage size.",
                                    "old": "Maximum IOPS supported by this #Vcores or PremiumV2_LRS Storage Size"
                                  }
                                },
                                {
                                  "#name": "storageSizeMb",
                                  "Description": {
                                    "new": "Minimum supported size (in MB) of storage.",
                                    "old": "Storage size in MB"
                                  }
                                },
                                {
                                  "#name": "maximumStorageSizeMb",
                                  "Description": {
                                    "new": "Maximum supported size (in MB) of storage.",
                                    "old": "Maximum value of Storage size in MB"
                                  }
                                },
                                {
                                  "#name": "supportedThroughput",
                                  "Description": {
                                    "new": "Minimum supported throughput (in MB/s) of storage.",
                                    "old": "Values of throughput in MB/s"
                                  }
                                },
                                {
                                  "#name": "supportedMaximumThroughput",
                                  "Description": {
                                    "new": "Maximum supported throughput (in MB/s) of storage.",
                                    "old": "Maximum values of throughput in MB/s"
                                  }
                                },
                                {
                                  "#name": "defaultIopsTier",
                                  "Description": {
                                    "new": "Default IOPS for this tier and storage size.",
                                    "old": "Default tier for IOPS"
                                  }
                                },
                                {
                                  "#name": "supportedIopsTiers",
                                  "Description": {
                                    "new": "List of all supported storage tiers for this tier and storage size.",
                                    "old": "List of available options to upgrade the storage performance"
                                  },
                                  "$items": {
                                    "Description": {
                                      "new": "Capability of a storage tier.",
                                      "old": "Represents capability of a storage tier"
                                    },
                                    "$properties": [
                                      {
                                        "#name": "name",
                                        "Description": {
                                          "new": "Name of the storage tier.",
                                          "old": "Name to represent Storage tier capability"
                                        }
                                      },
                                      {
                                        "#name": "iops",
                                        "Description": {
                                          "new": "Supported IOPS for the storage tier.",
                                          "old": "Supported IOPS for this storage tier"
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    },
                    {
                      "#name": "supportedServerSkus",
                      "Description": {
                        "new": "List of supported compute names (SKUs).",
                        "old": "List of supported server SKUs."
                      },
                      "$items": {
                        "Description": {
                          "new": "Capabilities in terms of compute.",
                          "old": "Sku capability"
                        },
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Name of the compute (SKU).",
                              "old": "Sku name"
                            }
                          },
                          {
                            "#name": "vCores",
                            "Description": {
                              "new": "vCores available for this compute.",
                              "old": "Supported vCores"
                            }
                          },
                          {
                            "#name": "supportedIops",
                            "Description": {
                              "new": "Maximum IOPS supported by this compute.",
                              "old": "Supported IOPS"
                            }
                          },
                          {
                            "#name": "supportedMemoryPerVcoreMb",
                            "Description": {
                              "new": "Supported memory (in MB) per virtual core assigned to this compute.",
                              "old": "Supported memory per vCore in MB"
                            }
                          },
                          {
                            "#name": "supportedZones",
                            "Description": {
                              "new": "List of supported availability zones. E.g. \"1\", \"2\", \"3\"",
                              "old": "List of supported Availability Zones. E.g. \"1\", \"2\", \"3\""
                            }
                          },
                          {
                            "#name": "supportedHaMode",
                            "Description": {
                              "new": "Modes of high availability supported for this compute.",
                              "old": "Supported high availability mode"
                            },
                            "$items": {
                              "Description": {
                                "new": "Modes of high availability supported for this compute.",
                                "old": "HA mode supported for a server."
                              }
                            }
                          },
                          {
                            "#name": "supportedFeatures",
                            "Description": {
                              "new": "Features supported.",
                              "old": "The supported features."
                            },
                            "$items": {
                              "Description": {
                                "new": "Features supported.",
                                "old": "The supported features."
                              },
                              "$properties": [
                                {
                                  "#name": "name",
                                  "Description": {
                                    "new": "Name of the feature.",
                                    "old": "Name of feature"
                                  }
                                },
                                {
                                  "#name": "status",
                                  "Description": {
                                    "new": "Status of the feature. Indicates if the feature is enabled or not.",
                                    "old": "Status of feature "
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "securityProfile",
                            "Description": {
                              "new": "Security profile of the compute. Indicates if it's a Confidential Compute virtual machine.",
                              "old": "The value of security profile indicating if its confidential vm"
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "supportedServerVersions",
                "Description": {
                  "new": "List of supported major versions of PostgreSQL database engine.",
                  "old": "The list of server versions supported for this capability."
                },
                "$items": {
                  "Description": {
                    "new": "Capabilities in terms of major versions of PostgreSQL database engine.",
                    "old": "Server version capabilities."
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Major version of PostgreSQL database engine.",
                        "old": "Server version"
                      }
                    },
                    {
                      "#name": "supportedVersionsToUpgrade",
                      "Description": {
                        "new": "Major versions of PostgreSQL database engine to which this version can be automatically upgraded.",
                        "old": "Supported servers versions to upgrade"
                      }
                    },
                    {
                      "#name": "supportedFeatures",
                      "Description": {
                        "new": "Features supported.",
                        "old": "The supported features."
                      },
                      "$items": {
                        "Description": {
                          "new": "Features supported.",
                          "old": "The supported features."
                        },
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Name of the feature.",
                              "old": "Name of feature"
                            }
                          },
                          {
                            "#name": "status",
                            "Description": {
                              "new": "Status of the feature. Indicates if the feature is enabled or not.",
                              "old": "Status of feature "
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "supportedFeatures",
                "Description": {
                  "new": "Features supported.",
                  "old": "The supported features."
                },
                "$items": {
                  "Description": {
                    "new": "Features supported.",
                    "old": "The supported features."
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Name of the feature.",
                        "old": "Name of feature"
                      }
                    },
                    {
                      "#name": "status",
                      "Description": {
                        "new": "Status of the feature. Indicates if the feature is enabled or not.",
                        "old": "Status of feature "
                      }
                    }
                  ]
                }
              },
              {
                "#name": "fastProvisioningSupported",
                "Description": {
                  "new": "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\".",
                  "old": "Gets a value indicating whether fast provisioning is supported. \"Enabled\" means fast provisioning is supported. \"Disabled\" stands for fast provisioning is not supported. Will be deprecated in future, please look to Supported Features for \"FastProvisioning\"."
                }
              },
              {
                "#name": "supportedFastProvisioningEditions",
                "Description": {
                  "new": "List of compute tiers supporting fast provisioning.",
                  "old": "List of supported server editions for fast provisioning"
                },
                "$items": {
                  "Description": {
                    "new": "Capability of a fast provisioning compute tier.",
                    "old": "Represents capability of a fast provisioning edition"
                  },
                  "$properties": [
                    {
                      "#name": "supportedTier",
                      "Description": {
                        "new": "Compute tier supporting fast provisioning.",
                        "old": "Fast provisioning supported tier name"
                      }
                    },
                    {
                      "#name": "supportedSku",
                      "Description": {
                        "new": "Compute name (SKU) supporting fast provisioning.",
                        "old": "Fast provisioning supported sku name"
                      }
                    },
                    {
                      "#name": "supportedStorageGb",
                      "Description": {
                        "new": "Storage size (in GB) supporting fast provisioning.",
                        "old": "Fast provisioning supported storage in Gb"
                      }
                    },
                    {
                      "#name": "supportedServerVersions",
                      "Description": {
                        "new": "Major version of PostgreSQL database engine supporting fast provisioning.",
                        "old": "Fast provisioning supported version"
                      }
                    },
                    {
                      "#name": "serverCount",
                      "Description": {
                        "new": "Count of servers in cache matching this specification.",
                        "old": "Count of servers in cache matching the spec"
                      }
                    }
                  ]
                }
              },
              {
                "#name": "geoBackupSupported",
                "Description": {
                  "new": "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\".",
                  "old": "Determines if geo-backup is supported in this region. \"Enabled\" means geo-backup is supported. \"Disabled\" stands for geo-back is not supported. Will be deprecated in future, please look to Supported Features for \"GeoBackup\"."
                }
              },
              {
                "#name": "zoneRedundantHaSupported",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether Zone Redundant HA is supported in this region. \"Enabled\" means zone redundant HA is supported. \"Disabled\" stands for zone redundant HA is not supported. Will be deprecated in future, please look to Supported Features for \"ZoneRedundantHa\"."
                }
              },
              {
                "#name": "zoneRedundantHaAndGeoBackupSupported",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether Zone Redundant HA and Geo-backup is supported in this region. \"Enabled\" means zone redundant HA and geo-backup is supported. \"Disabled\" stands for zone redundant HA and geo-backup is not supported. Will be deprecated in future, please look to Supported Features for \"ZoneRedundantHaAndGeoBackup\"."
                }
              },
              {
                "#name": "storageAutoGrowthSupported",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether storage auto-grow is supported in this region. \"Enabled\" means storage auto-grow is supported. \"Disabled\" stands for storage auto-grow is not supported. Will be deprecated in future, please look to Supported Features for \"StorageAutoGrowth\"."
                }
              },
              {
                "#name": "onlineResizeSupported",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether online resize is supported in this region for the given subscription. \"Enabled\" means storage online resize is supported. \"Disabled\" means storage online resize is not supported. Will be deprecated in future, please look to Supported Features for \"OnlineResize\"."
                }
              },
              {
                "#name": "restricted",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether this region is restricted. \"Enabled\" means region is restricted. \"Disabled\" stands for region is not restricted. Will be deprecated in future, please look to Supported Features for \"Restricted\"."
                }
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ 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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerCapabilities_List (updated)
Description :  Lists the capabilities available for a given flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerCapabilities_List",
  "Description": {
    "new": "Lists the capabilities available for a given flexible server.",
    "old": "Get capabilities for a flexible server."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Capability for the Azure Database for PostgreSQL flexible server.",
        "old": "Capability for the PostgreSQL server"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of supported capabilities.",
            "old": "A list of supported capabilities."
          },
          "$items": {
            "Description": {
              "new": "Capability for the Azure Database for PostgreSQL flexible server.",
              "old": "Capability for the PostgreSQL server"
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name of flexible servers capabilities.",
                  "old": "Name of flexible servers capability"
                }
              },
              {
                "#name": "supportedServerEditions",
                "Description": {
                  "new": "List of supported compute tiers.",
                  "old": "List of supported flexible server editions"
                },
                "$items": {
                  "Description": {
                    "new": "Capabilities in terms of compute tier.",
                    "old": "Flexible server edition capabilities."
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Name of compute tier.",
                        "old": "Server edition name"
                      }
                    },
                    {
                      "#name": "defaultSkuName",
                      "Description": {
                        "new": "Default compute name (SKU) for this computer tier.",
                        "old": "Default sku name for the server edition"
                      }
                    },
                    {
                      "#name": "supportedStorageEditions",
                      "Description": {
                        "new": "List of storage editions supported by this compute tier and compute name.",
                        "old": "The list of editions supported by this server edition."
                      },
                      "$items": {
                        "Description": {
                          "new": "Capabilities in terms of storage tier.",
                          "old": "Storage edition capability"
                        },
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Name of storage tier.",
                              "old": "Storage edition name"
                            }
                          },
                          {
                            "#name": "defaultStorageSizeMb",
                            "Description": {
                              "new": "Default storage size (in MB) for this storage tier.",
                              "old": "Default storage size in MB for storage edition"
                            }
                          },
                          {
                            "#name": "supportedStorageMb",
                            "Description": {
                              "new": "Configurations of storage supported for this storage tier.",
                              "old": "Flexible server supported storage range in MB"
                            },
                            "$items": {
                              "Description": {
                                "new": "Storage size (in MB) capability.",
                                "old": "storage size in MB capability"
                              },
                              "$properties": [
                                {
                                  "#name": "supportedIops",
                                  "Description": {
                                    "new": "Minimum IOPS supported by the storage size.",
                                    "old": "Supported IOPS"
                                  }
                                },
                                {
                                  "#name": "supportedMaximumIops",
                                  "Description": {
                                    "new": "Maximum IOPS supported by the storage size.",
                                    "old": "Maximum IOPS supported by this #Vcores or PremiumV2_LRS Storage Size"
                                  }
                                },
                                {
                                  "#name": "storageSizeMb",
                                  "Description": {
                                    "new": "Minimum supported size (in MB) of storage.",
                                    "old": "Storage size in MB"
                                  }
                                },
                                {
                                  "#name": "maximumStorageSizeMb",
                                  "Description": {
                                    "new": "Maximum supported size (in MB) of storage.",
                                    "old": "Maximum value of Storage size in MB"
                                  }
                                },
                                {
                                  "#name": "supportedThroughput",
                                  "Description": {
                                    "new": "Minimum supported throughput (in MB/s) of storage.",
                                    "old": "Values of throughput in MB/s"
                                  }
                                },
                                {
                                  "#name": "supportedMaximumThroughput",
                                  "Description": {
                                    "new": "Maximum supported throughput (in MB/s) of storage.",
                                    "old": "Maximum values of throughput in MB/s"
                                  }
                                },
                                {
                                  "#name": "defaultIopsTier",
                                  "Description": {
                                    "new": "Default IOPS for this tier and storage size.",
                                    "old": "Default tier for IOPS"
                                  }
                                },
                                {
                                  "#name": "supportedIopsTiers",
                                  "Description": {
                                    "new": "List of all supported storage tiers for this tier and storage size.",
                                    "old": "List of available options to upgrade the storage performance"
                                  },
                                  "$items": {
                                    "Description": {
                                      "new": "Capability of a storage tier.",
                                      "old": "Represents capability of a storage tier"
                                    },
                                    "$properties": [
                                      {
                                        "#name": "name",
                                        "Description": {
                                          "new": "Name of the storage tier.",
                                          "old": "Name to represent Storage tier capability"
                                        }
                                      },
                                      {
                                        "#name": "iops",
                                        "Description": {
                                          "new": "Supported IOPS for the storage tier.",
                                          "old": "Supported IOPS for this storage tier"
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    },
                    {
                      "#name": "supportedServerSkus",
                      "Description": {
                        "new": "List of supported compute names (SKUs).",
                        "old": "List of supported server SKUs."
                      },
                      "$items": {
                        "Description": {
                          "new": "Capabilities in terms of compute.",
                          "old": "Sku capability"
                        },
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Name of the compute (SKU).",
                              "old": "Sku name"
                            }
                          },
                          {
                            "#name": "vCores",
                            "Description": {
                              "new": "vCores available for this compute.",
                              "old": "Supported vCores"
                            }
                          },
                          {
                            "#name": "supportedIops",
                            "Description": {
                              "new": "Maximum IOPS supported by this compute.",
                              "old": "Supported IOPS"
                            }
                          },
                          {
                            "#name": "supportedMemoryPerVcoreMb",
                            "Description": {
                              "new": "Supported memory (in MB) per virtual core assigned to this compute.",
                              "old": "Supported memory per vCore in MB"
                            }
                          },
                          {
                            "#name": "supportedZones",
                            "Description": {
                              "new": "List of supported availability zones. E.g. \"1\", \"2\", \"3\"",
                              "old": "List of supported Availability Zones. E.g. \"1\", \"2\", \"3\""
                            }
                          },
                          {
                            "#name": "supportedHaMode",
                            "Description": {
                              "new": "Modes of high availability supported for this compute.",
                              "old": "Supported high availability mode"
                            },
                            "$items": {
                              "Description": {
                                "new": "Modes of high availability supported for this compute.",
                                "old": "HA mode supported for a server."
                              }
                            }
                          },
                          {
                            "#name": "supportedFeatures",
                            "Description": {
                              "new": "Features supported.",
                              "old": "The supported features."
                            },
                            "$items": {
                              "Description": {
                                "new": "Features supported.",
                                "old": "The supported features."
                              },
                              "$properties": [
                                {
                                  "#name": "name",
                                  "Description": {
                                    "new": "Name of the feature.",
                                    "old": "Name of feature"
                                  }
                                },
                                {
                                  "#name": "status",
                                  "Description": {
                                    "new": "Status of the feature. Indicates if the feature is enabled or not.",
                                    "old": "Status of feature "
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "securityProfile",
                            "Description": {
                              "new": "Security profile of the compute. Indicates if it's a Confidential Compute virtual machine.",
                              "old": "The value of security profile indicating if its confidential vm"
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "supportedServerVersions",
                "Description": {
                  "new": "List of supported major versions of PostgreSQL database engine.",
                  "old": "The list of server versions supported for this capability."
                },
                "$items": {
                  "Description": {
                    "new": "Capabilities in terms of major versions of PostgreSQL database engine.",
                    "old": "Server version capabilities."
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Major version of PostgreSQL database engine.",
                        "old": "Server version"
                      }
                    },
                    {
                      "#name": "supportedVersionsToUpgrade",
                      "Description": {
                        "new": "Major versions of PostgreSQL database engine to which this version can be automatically upgraded.",
                        "old": "Supported servers versions to upgrade"
                      }
                    },
                    {
                      "#name": "supportedFeatures",
                      "Description": {
                        "new": "Features supported.",
                        "old": "The supported features."
                      },
                      "$items": {
                        "Description": {
                          "new": "Features supported.",
                          "old": "The supported features."
                        },
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Name of the feature.",
                              "old": "Name of feature"
                            }
                          },
                          {
                            "#name": "status",
                            "Description": {
                              "new": "Status of the feature. Indicates if the feature is enabled or not.",
                              "old": "Status of feature "
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "supportedFeatures",
                "Description": {
                  "new": "Features supported.",
                  "old": "The supported features."
                },
                "$items": {
                  "Description": {
                    "new": "Features supported.",
                    "old": "The supported features."
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Name of the feature.",
                        "old": "Name of feature"
                      }
                    },
                    {
                      "#name": "status",
                      "Description": {
                        "new": "Status of the feature. Indicates if the feature is enabled or not.",
                        "old": "Status of feature "
                      }
                    }
                  ]
                }
              },
              {
                "#name": "fastProvisioningSupported",
                "Description": {
                  "new": "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\".",
                  "old": "Gets a value indicating whether fast provisioning is supported. \"Enabled\" means fast provisioning is supported. \"Disabled\" stands for fast provisioning is not supported. Will be deprecated in future, please look to Supported Features for \"FastProvisioning\"."
                }
              },
              {
                "#name": "supportedFastProvisioningEditions",
                "Description": {
                  "new": "List of compute tiers supporting fast provisioning.",
                  "old": "List of supported server editions for fast provisioning"
                },
                "$items": {
                  "Description": {
                    "new": "Capability of a fast provisioning compute tier.",
                    "old": "Represents capability of a fast provisioning edition"
                  },
                  "$properties": [
                    {
                      "#name": "supportedTier",
                      "Description": {
                        "new": "Compute tier supporting fast provisioning.",
                        "old": "Fast provisioning supported tier name"
                      }
                    },
                    {
                      "#name": "supportedSku",
                      "Description": {
                        "new": "Compute name (SKU) supporting fast provisioning.",
                        "old": "Fast provisioning supported sku name"
                      }
                    },
                    {
                      "#name": "supportedStorageGb",
                      "Description": {
                        "new": "Storage size (in GB) supporting fast provisioning.",
                        "old": "Fast provisioning supported storage in Gb"
                      }
                    },
                    {
                      "#name": "supportedServerVersions",
                      "Description": {
                        "new": "Major version of PostgreSQL database engine supporting fast provisioning.",
                        "old": "Fast provisioning supported version"
                      }
                    },
                    {
                      "#name": "serverCount",
                      "Description": {
                        "new": "Count of servers in cache matching this specification.",
                        "old": "Count of servers in cache matching the spec"
                      }
                    }
                  ]
                }
              },
              {
                "#name": "geoBackupSupported",
                "Description": {
                  "new": "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\".",
                  "old": "Determines if geo-backup is supported in this region. \"Enabled\" means geo-backup is supported. \"Disabled\" stands for geo-back is not supported. Will be deprecated in future, please look to Supported Features for \"GeoBackup\"."
                }
              },
              {
                "#name": "zoneRedundantHaSupported",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether Zone Redundant HA is supported in this region. \"Enabled\" means zone redundant HA is supported. \"Disabled\" stands for zone redundant HA is not supported. Will be deprecated in future, please look to Supported Features for \"ZoneRedundantHa\"."
                }
              },
              {
                "#name": "zoneRedundantHaAndGeoBackupSupported",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether Zone Redundant HA and Geo-backup is supported in this region. \"Enabled\" means zone redundant HA and geo-backup is supported. \"Disabled\" stands for zone redundant HA and geo-backup is not supported. Will be deprecated in future, please look to Supported Features for \"ZoneRedundantHaAndGeoBackup\"."
                }
              },
              {
                "#name": "storageAutoGrowthSupported",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether storage auto-grow is supported in this region. \"Enabled\" means storage auto-grow is supported. \"Disabled\" stands for storage auto-grow is not supported. Will be deprecated in future, please look to Supported Features for \"StorageAutoGrowth\"."
                }
              },
              {
                "#name": "onlineResizeSupported",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether online resize is supported in this region for the given subscription. \"Enabled\" means storage online resize is supported. \"Disabled\" means storage online resize is not supported. Will be deprecated in future, please look to Supported Features for \"OnlineResize\"."
                }
              },
              {
                "#name": "restricted",
                "Description": {
                  "new": "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\".",
                  "old": "A value indicating whether this region is restricted. \"Enabled\" means region is restricted. \"Disabled\" stands for region is not restricted. Will be deprecated in future, please look to Supported Features for \"Restricted\"."
                }
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ 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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckNameAvailability_Execute (updated)
Description :  Checks the validity and availability of the given name, to assign it to a new flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CheckNameAvailability_Execute",
  "Description": {
    "new": "Checks the validity and availability of the given name, to assign it to a new flexible server.",
    "old": "Check the availability of name for resource"
  },
  "$parameters": [
    {
      "#name": "nameAvailabilityRequest",
      "Description": {
        "new": "Parameters required to check if a server name is valid and available to assign it to a new flexible server.",
        "old": "The required parameters for checking if resource name is available."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Availability of a server name.",
        "old": "Represents a resource name availability."
      },
      "$properties": [
        {
          "#name": "name",
          "Description": {
            "new": "Name of the PostgreSQL flexible server.",
            "old": "name of the PostgreSQL server."
          }
        },
        {
          "#name": "type",
          "Description": {
            "new": "Type of the server.",
            "old": "type of the server"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: Parameters required to check if a server name is valid and available to assign it to a new flexible server. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the PostgreSQL flexible server. ,
Required: False ,
}
string ,
type:
{
Description: Type of the server. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckNameAvailabilityWithLocation_Execute (updated)
Description :  Check the availability of name for resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "CheckNameAvailabilityWithLocation_Execute",
  "$parameters": [
    {
      "#name": "nameAvailabilityRequest",
      "Description": {
        "new": "Parameters required to check if server name is available.",
        "old": "The required parameters for checking if resource name is available."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Availability of a server name.",
        "old": "Represents a resource name availability."
      },
      "$properties": [
        {
          "#name": "name",
          "Description": {
            "new": "Name of the PostgreSQL flexible server.",
            "old": "name of the PostgreSQL server."
          }
        },
        {
          "#name": "type",
          "Description": {
            "new": "Type of the server.",
            "old": "type of the server"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: Parameters required to check if server name is available. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the PostgreSQL flexible server. ,
Required: False ,
}
string ,
type:
{
Description: Type of the server. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_ListByServer (updated)
Description :  Lists all server parameters (also known as configurations) of a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_ListByServer",
  "Description": {
    "new": "Lists all server parameters (also known as configurations) of a flexible server.",
    "old": "List all the configurations in a given server."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of server parameters.",
        "old": "A list of server configurations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of server parameters.",
            "old": "The list of server configurations."
          },
          "$items": {
            "Description": {
              "new": "Server parameter.",
              "old": "Represents a Configuration."
            },
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Properties of a server parameter.",
                  "old": "The properties of a configuration."
                },
                "$properties": [
                  {
                    "#name": "value",
                    "Description": {
                      "new": "Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.",
                      "old": "Value of the configuration. Required to update the configuration."
                    }
                  },
                  {
                    "#name": "description",
                    "Description": {
                      "new": "Description of the server parameter.",
                      "old": "Description of the configuration."
                    }
                  },
                  {
                    "#name": "defaultValue",
                    "Description": {
                      "new": "Value assigned by default to the server parameter.",
                      "old": "Default value of the configuration."
                    }
                  },
                  {
                    "#name": "dataType",
                    "Description": {
                      "new": "Data type of the server parameter.",
                      "old": "Data type of the configuration."
                    }
                  },
                  {
                    "#name": "allowedValues",
                    "Description": {
                      "new": "Allowed values of the server parameter.",
                      "old": "Allowed values of the configuration."
                    }
                  },
                  {
                    "#name": "source",
                    "Description": {
                      "new": "Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.",
                      "old": "Source of the configuration. Required to update the configuration."
                    }
                  },
                  {
                    "#name": "isDynamicConfig",
                    "Description": {
                      "new": "Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.",
                      "old": "Configuration dynamic or static."
                    }
                  },
                  {
                    "#name": "isReadOnly",
                    "Description": {
                      "new": "Indicates if it's a read-only (true) or modifiable (false) server parameter.",
                      "old": "Configuration read-only or not."
                    }
                  },
                  {
                    "#name": "isConfigPendingRestart",
                    "Description": {
                      "new": "Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.",
                      "old": "Configuration is pending restart or not."
                    }
                  },
                  {
                    "#name": "unit",
                    "Description": {
                      "new": "Units in which the server parameter value is expressed.",
                      "old": "Configuration unit."
                    }
                  },
                  {
                    "#name": "documentationLink",
                    "Description": {
                      "new": "Link pointing to the documentation of the server parameter.",
                      "old": "Configuration documentation link."
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "The link used to get the next page of operations."
          }
        }
      ]
    }
  }
}

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

⚶ Changes

{
  "#id": "Configurations_Get",
  "Description": {
    "new": "Gets information about a specific server parameter of a flexible server.",
    "old": "Gets information about a configuration of server."
  },
  "$parameters": [
    {
      "#name": "configurationName",
      "Description": {
        "new": "Name of the server parameter.",
        "old": "The name of the server configuration."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Server parameter.",
        "old": "Represents a Configuration."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a server parameter.",
            "old": "The properties of a configuration."
          },
          "$properties": [
            {
              "#name": "value",
              "Description": {
                "new": "Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Value of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "description",
              "Description": {
                "new": "Description of the server parameter.",
                "old": "Description of the configuration."
              }
            },
            {
              "#name": "defaultValue",
              "Description": {
                "new": "Value assigned by default to the server parameter.",
                "old": "Default value of the configuration."
              }
            },
            {
              "#name": "dataType",
              "Description": {
                "new": "Data type of the server parameter.",
                "old": "Data type of the configuration."
              }
            },
            {
              "#name": "allowedValues",
              "Description": {
                "new": "Allowed values of the server parameter.",
                "old": "Allowed values of the configuration."
              }
            },
            {
              "#name": "source",
              "Description": {
                "new": "Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Source of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "isDynamicConfig",
              "Description": {
                "new": "Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.",
                "old": "Configuration dynamic or static."
              }
            },
            {
              "#name": "isReadOnly",
              "Description": {
                "new": "Indicates if it's a read-only (true) or modifiable (false) server parameter.",
                "old": "Configuration read-only or not."
              }
            },
            {
              "#name": "isConfigPendingRestart",
              "Description": {
                "new": "Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.",
                "old": "Configuration is pending restart or not."
              }
            },
            {
              "#name": "unit",
              "Description": {
                "new": "Units in which the server parameter value is expressed.",
                "old": "Configuration unit."
              }
            },
            {
              "#name": "documentationLink",
              "Description": {
                "new": "Link pointing to the documentation of the server parameter.",
                "old": "Configuration documentation link."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚶ Changes

{
  "#id": "Configurations_Update",
  "Description": {
    "new": "Updates, using Patch verb, the value assigned to a specific modifiable server parameter of a flexible server.",
    "old": "Updates a configuration of a server."
  },
  "$parameters": [
    {
      "#name": "configurationName",
      "Description": {
        "new": "Name of the server parameter.",
        "old": "The name of the server configuration."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required to update the value of a specific modifiable server parameter.",
        "old": "The required parameters for updating a server configuration."
      },
      "$schema": {
        "Description": {
          "new": "Server parameter.",
          "old": "Represents a Configuration."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Properties of a server parameter.",
              "old": "The properties of a configuration."
            },
            "$properties": [
              {
                "#name": "value",
                "Description": {
                  "new": "Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.",
                  "old": "Value of the configuration. Required to update the configuration."
                }
              },
              {
                "#name": "description",
                "Description": {
                  "new": "Description of the server parameter.",
                  "old": "Description of the configuration."
                }
              },
              {
                "#name": "defaultValue",
                "Description": {
                  "new": "Value assigned by default to the server parameter.",
                  "old": "Default value of the configuration."
                }
              },
              {
                "#name": "dataType",
                "Description": {
                  "new": "Data type of the server parameter.",
                  "old": "Data type of the configuration."
                }
              },
              {
                "#name": "allowedValues",
                "Description": {
                  "new": "Allowed values of the server parameter.",
                  "old": "Allowed values of the configuration."
                }
              },
              {
                "#name": "source",
                "Description": {
                  "new": "Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.",
                  "old": "Source of the configuration. Required to update the configuration."
                }
              },
              {
                "#name": "isDynamicConfig",
                "Description": {
                  "new": "Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.",
                  "old": "Configuration dynamic or static."
                }
              },
              {
                "#name": "isReadOnly",
                "Description": {
                  "new": "Indicates if it's a read-only (true) or modifiable (false) server parameter.",
                  "old": "Configuration read-only or not."
                }
              },
              {
                "#name": "isConfigPendingRestart",
                "Description": {
                  "new": "Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.",
                  "old": "Configuration is pending restart or not."
                }
              },
              {
                "#name": "unit",
                "Description": {
                  "new": "Units in which the server parameter value is expressed.",
                  "old": "Configuration unit."
                }
              },
              {
                "#name": "documentationLink",
                "Description": {
                  "new": "Link pointing to the documentation of the server parameter.",
                  "old": "Configuration documentation link."
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Server parameter.",
        "old": "Represents a Configuration."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a server parameter.",
            "old": "The properties of a configuration."
          },
          "$properties": [
            {
              "#name": "value",
              "Description": {
                "new": "Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Value of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "description",
              "Description": {
                "new": "Description of the server parameter.",
                "old": "Description of the configuration."
              }
            },
            {
              "#name": "defaultValue",
              "Description": {
                "new": "Value assigned by default to the server parameter.",
                "old": "Default value of the configuration."
              }
            },
            {
              "#name": "dataType",
              "Description": {
                "new": "Data type of the server parameter.",
                "old": "Data type of the configuration."
              }
            },
            {
              "#name": "allowedValues",
              "Description": {
                "new": "Allowed values of the server parameter.",
                "old": "Allowed values of the configuration."
              }
            },
            {
              "#name": "source",
              "Description": {
                "new": "Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Source of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "isDynamicConfig",
              "Description": {
                "new": "Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.",
                "old": "Configuration dynamic or static."
              }
            },
            {
              "#name": "isReadOnly",
              "Description": {
                "new": "Indicates if it's a read-only (true) or modifiable (false) server parameter.",
                "old": "Configuration read-only or not."
              }
            },
            {
              "#name": "isConfigPendingRestart",
              "Description": {
                "new": "Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.",
                "old": "Configuration is pending restart or not."
              }
            },
            {
              "#name": "unit",
              "Description": {
                "new": "Units in which the server parameter value is expressed.",
                "old": "Configuration unit."
              }
            },
            {
              "#name": "documentationLink",
              "Description": {
                "new": "Link pointing to the documentation of the server parameter.",
                "old": "Configuration documentation link."
              }
            }
          ]
        }
      ]
    },
    "201": {
      "Description": {
        "new": "Server parameter.",
        "old": "Represents a Configuration."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a server parameter.",
            "old": "The properties of a configuration."
          },
          "$properties": [
            {
              "#name": "value",
              "Description": {
                "new": "Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Value of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "description",
              "Description": {
                "new": "Description of the server parameter.",
                "old": "Description of the configuration."
              }
            },
            {
              "#name": "defaultValue",
              "Description": {
                "new": "Value assigned by default to the server parameter.",
                "old": "Default value of the configuration."
              }
            },
            {
              "#name": "dataType",
              "Description": {
                "new": "Data type of the server parameter.",
                "old": "Data type of the configuration."
              }
            },
            {
              "#name": "allowedValues",
              "Description": {
                "new": "Allowed values of the server parameter.",
                "old": "Allowed values of the configuration."
              }
            },
            {
              "#name": "source",
              "Description": {
                "new": "Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Source of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "isDynamicConfig",
              "Description": {
                "new": "Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.",
                "old": "Configuration dynamic or static."
              }
            },
            {
              "#name": "isReadOnly",
              "Description": {
                "new": "Indicates if it's a read-only (true) or modifiable (false) server parameter.",
                "old": "Configuration read-only or not."
              }
            },
            {
              "#name": "isConfigPendingRestart",
              "Description": {
                "new": "Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.",
                "old": "Configuration is pending restart or not."
              }
            },
            {
              "#name": "unit",
              "Description": {
                "new": "Units in which the server parameter value is expressed.",
                "old": "Configuration unit."
              }
            },
            {
              "#name": "documentationLink",
              "Description": {
                "new": "Link pointing to the documentation of the server parameter.",
                "old": "Configuration documentation link."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
configurationName:
{
Description: Name of the server parameter. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to update the value of a specific modifiable server parameter. ,
Required: True ,
}
{
properties:
{
Description: Properties of a server parameter. ,
Required: False ,
}
{
value:
{
Description: Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter. ,
Required: False ,
}
string ,
description:
{
Description: Description of the server parameter. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Value assigned by default to the server parameter. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the server parameter. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the server parameter. ,
Required: False ,
}
string ,
source:
{
Description: Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Indicates if it's a read-only (true) or modifiable (false) server parameter. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect. ,
Required: False ,
}
boolean ,
unit:
{
Description: Units in which the server parameter value is expressed. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Link pointing to the documentation of the server parameter. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_Put (updated)
Description :  Updates, using Put verb, the value assigned to a specific modifiable server parameter of a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_Put",
  "Description": {
    "new": "Updates, using Put verb, the value assigned to a specific modifiable server parameter of a flexible server.",
    "old": "Updates a configuration of a server."
  },
  "$parameters": [
    {
      "#name": "configurationName",
      "Description": {
        "new": "Name of the server parameter.",
        "old": "The name of the server configuration."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required to update the value of a specific modifiable server parameter.",
        "old": "The required parameters for updating a server configuration."
      },
      "$schema": {
        "Description": {
          "new": "Server parameter.",
          "old": "Represents a Configuration."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Properties of a server parameter.",
              "old": "The properties of a configuration."
            },
            "$properties": [
              {
                "#name": "value",
                "Description": {
                  "new": "Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.",
                  "old": "Value of the configuration. Required to update the configuration."
                }
              },
              {
                "#name": "description",
                "Description": {
                  "new": "Description of the server parameter.",
                  "old": "Description of the configuration."
                }
              },
              {
                "#name": "defaultValue",
                "Description": {
                  "new": "Value assigned by default to the server parameter.",
                  "old": "Default value of the configuration."
                }
              },
              {
                "#name": "dataType",
                "Description": {
                  "new": "Data type of the server parameter.",
                  "old": "Data type of the configuration."
                }
              },
              {
                "#name": "allowedValues",
                "Description": {
                  "new": "Allowed values of the server parameter.",
                  "old": "Allowed values of the configuration."
                }
              },
              {
                "#name": "source",
                "Description": {
                  "new": "Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.",
                  "old": "Source of the configuration. Required to update the configuration."
                }
              },
              {
                "#name": "isDynamicConfig",
                "Description": {
                  "new": "Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.",
                  "old": "Configuration dynamic or static."
                }
              },
              {
                "#name": "isReadOnly",
                "Description": {
                  "new": "Indicates if it's a read-only (true) or modifiable (false) server parameter.",
                  "old": "Configuration read-only or not."
                }
              },
              {
                "#name": "isConfigPendingRestart",
                "Description": {
                  "new": "Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.",
                  "old": "Configuration is pending restart or not."
                }
              },
              {
                "#name": "unit",
                "Description": {
                  "new": "Units in which the server parameter value is expressed.",
                  "old": "Configuration unit."
                }
              },
              {
                "#name": "documentationLink",
                "Description": {
                  "new": "Link pointing to the documentation of the server parameter.",
                  "old": "Configuration documentation link."
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Server parameter.",
        "old": "Represents a Configuration."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a server parameter.",
            "old": "The properties of a configuration."
          },
          "$properties": [
            {
              "#name": "value",
              "Description": {
                "new": "Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Value of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "description",
              "Description": {
                "new": "Description of the server parameter.",
                "old": "Description of the configuration."
              }
            },
            {
              "#name": "defaultValue",
              "Description": {
                "new": "Value assigned by default to the server parameter.",
                "old": "Default value of the configuration."
              }
            },
            {
              "#name": "dataType",
              "Description": {
                "new": "Data type of the server parameter.",
                "old": "Data type of the configuration."
              }
            },
            {
              "#name": "allowedValues",
              "Description": {
                "new": "Allowed values of the server parameter.",
                "old": "Allowed values of the configuration."
              }
            },
            {
              "#name": "source",
              "Description": {
                "new": "Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Source of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "isDynamicConfig",
              "Description": {
                "new": "Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.",
                "old": "Configuration dynamic or static."
              }
            },
            {
              "#name": "isReadOnly",
              "Description": {
                "new": "Indicates if it's a read-only (true) or modifiable (false) server parameter.",
                "old": "Configuration read-only or not."
              }
            },
            {
              "#name": "isConfigPendingRestart",
              "Description": {
                "new": "Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.",
                "old": "Configuration is pending restart or not."
              }
            },
            {
              "#name": "unit",
              "Description": {
                "new": "Units in which the server parameter value is expressed.",
                "old": "Configuration unit."
              }
            },
            {
              "#name": "documentationLink",
              "Description": {
                "new": "Link pointing to the documentation of the server parameter.",
                "old": "Configuration documentation link."
              }
            }
          ]
        }
      ]
    },
    "201": {
      "Description": {
        "new": "Server parameter.",
        "old": "Represents a Configuration."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a server parameter.",
            "old": "The properties of a configuration."
          },
          "$properties": [
            {
              "#name": "value",
              "Description": {
                "new": "Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Value of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "description",
              "Description": {
                "new": "Description of the server parameter.",
                "old": "Description of the configuration."
              }
            },
            {
              "#name": "defaultValue",
              "Description": {
                "new": "Value assigned by default to the server parameter.",
                "old": "Default value of the configuration."
              }
            },
            {
              "#name": "dataType",
              "Description": {
                "new": "Data type of the server parameter.",
                "old": "Data type of the configuration."
              }
            },
            {
              "#name": "allowedValues",
              "Description": {
                "new": "Allowed values of the server parameter.",
                "old": "Allowed values of the configuration."
              }
            },
            {
              "#name": "source",
              "Description": {
                "new": "Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.",
                "old": "Source of the configuration. Required to update the configuration."
              }
            },
            {
              "#name": "isDynamicConfig",
              "Description": {
                "new": "Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.",
                "old": "Configuration dynamic or static."
              }
            },
            {
              "#name": "isReadOnly",
              "Description": {
                "new": "Indicates if it's a read-only (true) or modifiable (false) server parameter.",
                "old": "Configuration read-only or not."
              }
            },
            {
              "#name": "isConfigPendingRestart",
              "Description": {
                "new": "Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.",
                "old": "Configuration is pending restart or not."
              }
            },
            {
              "#name": "unit",
              "Description": {
                "new": "Units in which the server parameter value is expressed.",
                "old": "Configuration unit."
              }
            },
            {
              "#name": "documentationLink",
              "Description": {
                "new": "Link pointing to the documentation of the server parameter.",
                "old": "Configuration documentation link."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
configurationName:
{
Description: Name of the server parameter. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to update the value of a specific modifiable server parameter. ,
Required: True ,
}
{
properties:
{
Description: Properties of a server parameter. ,
Required: False ,
}
{
value:
{
Description: Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter. ,
Required: False ,
}
string ,
description:
{
Description: Description of the server parameter. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Value assigned by default to the server parameter. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the server parameter. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the server parameter. ,
Required: False ,
}
string ,
source:
{
Description: Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter. ,
Required: False ,
}
string ,
isDynamicConfig:
{
Description: Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect. ,
Required: False ,
}
boolean ,
isReadOnly:
{
Description: Indicates if it's a read-only (true) or modifiable (false) server parameter. ,
Required: False ,
}
boolean ,
isConfigPendingRestart:
{
Description: Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect. ,
Required: False ,
}
boolean ,
unit:
{
Description: Units in which the server parameter value is expressed. ,
Required: False ,
}
string ,
documentationLink:
{
Description: Link pointing to the documentation of the server parameter. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Create (updated)
Description :  Creates a new database.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Databases_Create",
  "Description": {
    "new": "Creates a new database.",
    "old": "Creates a new database or updates an existing database."
  },
  "$parameters": [
    {
      "#name": "databaseName",
      "Description": {
        "new": "Name of the database.",
        "old": "The name of the database."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required to create a new database.",
        "old": "The required parameters for creating or updating a database."
      },
      "$schema": {
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Properties of a database.",
              "old": "The properties of a database."
            },
            "$properties": [
              {
                "#name": "charset",
                "Description": {
                  "new": "Character set of the database.",
                  "old": "The charset of the database."
                }
              },
              {
                "#name": "collation",
                "Description": {
                  "new": "Collation of the database.",
                  "old": "The collation of the database."
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a database.",
            "old": "The properties of a database."
          },
          "$properties": [
            {
              "#name": "charset",
              "Description": {
                "new": "Character set of the database.",
                "old": "The charset of the database."
              }
            },
            {
              "#name": "collation",
              "Description": {
                "new": "Collation of the database.",
                "old": "The collation of the database."
              }
            }
          ]
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a database.",
            "old": "The properties of a database."
          },
          "$properties": [
            {
              "#name": "charset",
              "Description": {
                "new": "Character set of the database.",
                "old": "The charset of the database."
              }
            },
            {
              "#name": "collation",
              "Description": {
                "new": "Collation of the database.",
                "old": "The collation of the database."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: Name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to create a new database. ,
Required: True ,
}
{
properties:
{
Description: Properties of a database. ,
Required: False ,
}
{
charset:
{
Description: Character set of the database. ,
Required: False ,
}
string ,
collation:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a database. ,
Required: False ,
}
{
charset:
{
Description: Character set of the database. ,
Required: False ,
}
string ,
collation:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a database. ,
Required: False ,
}
{
charset:
{
Description: Character set of the database. ,
Required: False ,
}
string ,
collation:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Delete (updated)
Description :  Deletes an existing database.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Databases_Delete",
  "Description": {
    "new": "Deletes an existing database.",
    "old": "Deletes a database."
  },
  "$parameters": [
    {
      "#name": "databaseName",
      "Description": {
        "new": "Name of the database.",
        "old": "The name of the database."
      }
    }
  ]
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Databases_Get",
  "Description": {
    "new": "Gets information about an existing database.",
    "old": "Gets information about a database."
  },
  "$parameters": [
    {
      "#name": "databaseName",
      "Description": {
        "new": "Name of the database.",
        "old": "The name of the database."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a database.",
            "old": "The properties of a database."
          },
          "$properties": [
            {
              "#name": "charset",
              "Description": {
                "new": "Character set of the database.",
                "old": "The charset of the database."
              }
            },
            {
              "#name": "collation",
              "Description": {
                "new": "Collation of the database.",
                "old": "The collation of the database."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Properties of a database. ,
Required: False ,
}
{
charset:
{
Description: Character set of the database. ,
Required: False ,
}
string ,
collation:
{
Description: Collation of the database. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_ListByServer (updated)
Description :  Lists all databases in a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Databases_ListByServer",
  "Description": {
    "new": "Lists all databases in a flexible server.",
    "old": "List all the databases in a given server."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of all databases in a flexible server.",
        "old": "A List of databases."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of all databases in a flexible server.",
            "old": "The list of databases housed in a server"
          },
          "$items": {
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Properties of a database.",
                  "old": "The properties of a database."
                },
                "$properties": [
                  {
                    "#name": "charset",
                    "Description": {
                      "new": "Character set of the database.",
                      "old": "The charset of the database."
                    }
                  },
                  {
                    "#name": "collation",
                    "Description": {
                      "new": "Collation of the database.",
                      "old": "The collation of the database."
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "The link used to get the next page of databases."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of all databases in a flexible server. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a database. ,
Required: False ,
}
{
charset:
{
Description: Character set of the database. ,
Required: False ,
}
string ,
collation:
{
Description: Collation of the database. ,
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 ,
}
,
]
,
}
,
}
FirewallRules_CreateOrUpdate (updated)
Description :  Creates a new firewall rule or updates an existing firewall rule.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FirewallRules_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "firewallRuleName",
      "Description": {
        "new": "Name of the firewall rule.",
        "old": "The name of the server firewall rule."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required for creating or updating a firewall rule.",
        "old": "The required parameters for creating or updating a firewall rule."
      },
      "$schema": {
        "Description": {
          "new": "Firewall rule.",
          "old": "Represents a server firewall rule."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Properties of a firewall rule.",
              "old": "The properties of a firewall rule."
            },
            "$properties": [
              {
                "#name": "startIpAddress",
                "Description": {
                  "new": "IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                  "old": "The start IP address of the server firewall rule. Must be IPv4 format."
                }
              },
              {
                "#name": "endIpAddress",
                "Description": {
                  "new": "IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                  "old": "The end IP address of the server firewall rule. Must be IPv4 format."
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Firewall rule.",
        "old": "Represents a server firewall rule."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a firewall rule.",
            "old": "The properties of a firewall rule."
          },
          "$properties": [
            {
              "#name": "startIpAddress",
              "Description": {
                "new": "IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                "old": "The start IP address of the server firewall rule. Must be IPv4 format."
              }
            },
            {
              "#name": "endIpAddress",
              "Description": {
                "new": "IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                "old": "The end IP address of the server firewall rule. Must be IPv4 format."
              }
            }
          ]
        }
      ]
    },
    "201": {
      "Description": {
        "new": "Firewall rule.",
        "old": "Represents a server firewall rule."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a firewall rule.",
            "old": "The properties of a firewall rule."
          },
          "$properties": [
            {
              "#name": "startIpAddress",
              "Description": {
                "new": "IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                "old": "The start IP address of the server firewall rule. Must be IPv4 format."
              }
            },
            {
              "#name": "endIpAddress",
              "Description": {
                "new": "IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                "old": "The end IP address of the server firewall rule. Must be IPv4 format."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: Name of the firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required for creating or updating a firewall rule. ,
Required: True ,
}
{
properties:
{
Description: Properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FirewallRules_Delete (updated)
Description :  Deletes an existing firewall rule.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FirewallRules_Delete",
  "Description": {
    "new": "Deletes an existing firewall rule.",
    "old": "Deletes a PostgreSQL server firewall rule."
  },
  "$parameters": [
    {
      "#name": "firewallRuleName",
      "Description": {
        "new": "Name of the firewall rule.",
        "old": "The name of the server firewall rule."
      }
    }
  ]
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "FirewallRules_Get",
  "Description": {
    "new": "Gets information about a firewall rule in a flexible server.",
    "old": "List all the firewall rules in a given server."
  },
  "$parameters": [
    {
      "#name": "firewallRuleName",
      "Description": {
        "new": "Name of the firewall rule.",
        "old": "The name of the server firewall rule."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Firewall rule.",
        "old": "Represents a server firewall rule."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a firewall rule.",
            "old": "The properties of a firewall rule."
          },
          "$properties": [
            {
              "#name": "startIpAddress",
              "Description": {
                "new": "IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                "old": "The start IP address of the server firewall rule. Must be IPv4 format."
              }
            },
            {
              "#name": "endIpAddress",
              "Description": {
                "new": "IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                "old": "The end IP address of the server firewall rule. Must be IPv4 format."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FirewallRules_ListByServer (updated)
Description :  Lists information about all firewall rules in a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FirewallRules_ListByServer",
  "Description": {
    "new": "Lists information about all firewall rules in a flexible server.",
    "old": "List all the firewall rules in a given PostgreSQL server."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of firewall rules.",
        "old": "A list of firewall rules."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of firewall rules in a flexible server.",
            "old": "The list of firewall rules in a server."
          },
          "$items": {
            "Description": {
              "new": "Firewall rule.",
              "old": "Represents a server firewall rule."
            },
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Properties of a firewall rule.",
                  "old": "The properties of a firewall rule."
                },
                "$properties": [
                  {
                    "#name": "startIpAddress",
                    "Description": {
                      "new": "IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                      "old": "The start IP address of the server firewall rule. Must be IPv4 format."
                    }
                  },
                  {
                    "#name": "endIpAddress",
                    "Description": {
                      "new": "IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format.",
                      "old": "The end IP address of the server firewall rule. Must be IPv4 format."
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link to retrieve next page of results.",
            "old": "The link used to get the next page of operations."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of firewall rules in a flexible server. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Servers_Create",
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required to create a new flexible server or to update an existing flexible server.",
        "old": "The required parameters for creating or updating a server."
      },
      "$schema": {
        "Description": {
          "new": "Flexible server.",
          "old": "Represents a server."
        },
        "$properties": [
          {
            "#name": "sku",
            "Description": {
              "new": "Compute tier and size of a flexible server.",
              "old": "The SKU (pricing tier) of the server."
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name by which is known a given compute size assigned to a flexible server.",
                  "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                }
              },
              {
                "#name": "tier",
                "Description": {
                  "new": "Tier of the compute assigned to a flexible server.",
                  "old": "The tier of the particular SKU, e.g. Burstable."
                }
              }
            ]
          },
          {
            "#name": "identity",
            "Description": {
              "new": "User assigned managed identities assigned to the flexible server.",
              "old": "Describes the identity of the application."
            },
            "$properties": [
              {
                "#name": "userAssignedIdentities",
                "Description": {
                  "new": "Map of user assigned managed identities.",
                  "old": "represents user assigned identities map."
                }
              },
              {
                "#name": "principalId",
                "Description": {
                  "new": "Identifier of the object of the service principal associated to the user assigned managed identity.",
                  "old": "the identity principal Id of the server."
                }
              },
              {
                "#name": "type",
                "Description": {
                  "new": "Types of identities associated with a flexible server.",
                  "old": "the types of identities associated with this resource"
                }
              },
              {
                "#name": "tenantId",
                "Description": {
                  "new": "Identifier of the tenant of a flexible server.",
                  "old": "Tenant id of the server."
                }
              }
            ]
          },
          {
            "#name": "properties",
            "Description": {
              "new": "Properties of a flexible server.",
              "old": "Properties of the server."
            },
            "$properties": [
              {
                "#name": "administratorLogin",
                "Description": {
                  "new": "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.",
                  "old": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
                }
              },
              {
                "#name": "administratorLoginPassword",
                "Description": {
                  "new": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.",
                  "old": "The administrator login password (required for server creation)."
                }
              },
              {
                "#name": "version",
                "Description": {
                  "new": "Major version of PostgreSQL database engine.",
                  "old": "PostgreSQL Server version."
                }
              },
              {
                "#name": "minorVersion",
                "Description": {
                  "new": "Minor version of PostgreSQL database engine.",
                  "old": "The minor version of the server."
                }
              },
              {
                "#name": "state",
                "Description": {
                  "new": "Possible states of a flexible server.",
                  "old": "A state of a server that is visible to user."
                }
              },
              {
                "#name": "fullyQualifiedDomainName",
                "Description": {
                  "new": "Fully qualified domain name of a flexible server.",
                  "old": "The fully qualified domain name of a server."
                }
              },
              {
                "#name": "storage",
                "Description": {
                  "new": "Storage properties of a flexible server.",
                  "old": "Storage properties of a server."
                },
                "$properties": [
                  {
                    "#name": "storageSizeGB",
                    "Description": {
                      "new": "Size of storage assigned to a flexible server.",
                      "old": "Max storage allowed for a server."
                    }
                  },
                  {
                    "#name": "autoGrow",
                    "Description": {
                      "new": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.",
                      "old": "Flag to enable / disable Storage Auto grow for flexible server."
                    }
                  },
                  {
                    "#name": "tier",
                    "Description": {
                      "new": "Storage tier of a flexible server.",
                      "old": "Name of storage tier for IOPS."
                    }
                  },
                  {
                    "#name": "iops",
                    "Description": {
                      "new": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                      "old": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                    }
                  },
                  {
                    "#name": "throughput",
                    "Description": {
                      "new": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                      "old": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                    }
                  },
                  {
                    "#name": "type",
                    "Description": {
                      "new": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.",
                      "old": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified"
                    }
                  }
                ]
              },
              {
                "#name": "authConfig",
                "Description": {
                  "new": "Authentication configuration properties of a flexible server.",
                  "old": "AuthConfig properties of a server."
                },
                "$properties": [
                  {
                    "#name": "activeDirectoryAuth",
                    "Description": {
                      "new": "Indicates if the server supports Microsoft Entra authentication.",
                      "old": "If Enabled, Microsoft Entra authentication is enabled."
                    }
                  },
                  {
                    "#name": "passwordAuth",
                    "Description": {
                      "new": "Indicates if the server supports password based authentication.",
                      "old": "If Enabled, Password authentication is enabled."
                    }
                  },
                  {
                    "#name": "tenantId",
                    "Description": {
                      "new": "Identifier of the tenant of the delegated resource.",
                      "old": "Tenant id of the server."
                    }
                  }
                ]
              },
              {
                "#name": "dataEncryption",
                "Description": {
                  "new": "Data encryption properties of a flexible server.",
                  "old": "Data encryption properties of a server."
                },
                "$properties": [
                  {
                    "#name": "primaryKeyURI",
                    "Description": {
                      "new": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server.",
                      "old": "URI for the key in keyvault for data encryption of the primary server."
                    }
                  },
                  {
                    "#name": "primaryUserAssignedIdentityId",
                    "Description": {
                      "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server.",
                      "old": "Resource Id for the User assigned identity to be used for data encryption of the primary server."
                    }
                  },
                  {
                    "#name": "geoBackupKeyURI",
                    "Description": {
                      "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                      "old": "URI for the key in keyvault for data encryption for geo-backup of server."
                    }
                  },
                  {
                    "#name": "geoBackupUserAssignedIdentityId",
                    "Description": {
                      "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                      "old": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server."
                    }
                  },
                  {
                    "#name": "type",
                    "Description": {
                      "new": "Data encryption type used by a flexible server.",
                      "old": "Data encryption type to depict if it is System Managed vs Azure Key vault."
                    }
                  },
                  {
                    "#name": "primaryEncryptionKeyStatus",
                    "Description": {
                      "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.",
                      "old": "Primary encryption key status for Data encryption enabled server."
                    }
                  },
                  {
                    "#name": "geoBackupEncryptionKeyStatus",
                    "Description": {
                      "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.",
                      "old": "Geo-backup encryption key status for Data encryption enabled server."
                    }
                  }
                ]
              },
              {
                "#name": "backup",
                "Description": {
                  "new": "Backup properties of a flexible server.",
                  "old": "Backup properties of a server."
                },
                "$properties": [
                  {
                    "#name": "backupRetentionDays",
                    "Description": {
                      "new": "Backup retention days for the flexible server.",
                      "old": "Backup retention days for the server."
                    }
                  },
                  {
                    "#name": "geoRedundantBackup",
                    "Description": {
                      "new": "Indicates if the server is configured to create geographically redundant backups.",
                      "old": "A value indicating whether Geo-Redundant backup is enabled on the server."
                    }
                  },
                  {
                    "#name": "earliestRestoreDate",
                    "Description": {
                      "new": "Earliest restore point time (ISO8601 format) for a flexible server.",
                      "old": "The earliest restore point time (ISO8601 format) for server."
                    }
                  }
                ]
              },
              {
                "#name": "network",
                "Description": {
                  "new": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.",
                  "old": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server."
                },
                "$properties": [
                  {
                    "#name": "publicNetworkAccess",
                    "Description": {
                      "new": "Indicates if public network access is enabled or not.",
                      "old": "public network access is enabled or not"
                    }
                  },
                  {
                    "#name": "delegatedSubnetResourceId",
                    "Description": {
                      "new": "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.",
                      "old": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                    }
                  },
                  {
                    "#name": "privateDnsZoneArmResourceId",
                    "Description": {
                      "new": "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.",
                      "old": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                    }
                  }
                ]
              },
              {
                "#name": "highAvailability",
                "Description": {
                  "new": "High availability properties of a flexible server.",
                  "old": "High availability properties of a server."
                },
                "$properties": [
                  {
                    "#name": "mode",
                    "Description": {
                      "new": "High availability mode for a flexible server.",
                      "old": "The HA mode for the server."
                    }
                  },
                  {
                    "#name": "state",
                    "Description": {
                      "new": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.",
                      "old": "A state of a HA server that is visible to user."
                    }
                  },
                  {
                    "#name": "standbyAvailabilityZone",
                    "Description": {
                      "new": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.",
                      "old": "availability zone information of the standby."
                    }
                  }
                ]
              },
              {
                "#name": "maintenanceWindow",
                "Description": {
                  "new": "Maintenance window properties of a flexible server.",
                  "old": "Maintenance window properties of a server."
                },
                "$properties": [
                  {
                    "#name": "customWindow",
                    "Description": {
                      "new": "Indicates whether custom window is enabled or disabled.",
                      "old": "indicates whether custom window is enabled or disabled"
                    }
                  },
                  {
                    "#name": "startHour",
                    "Description": {
                      "new": "Start hour to be used for maintenance window.",
                      "old": "start hour for maintenance window"
                    }
                  },
                  {
                    "#name": "startMinute",
                    "Description": {
                      "new": "Start minute to be used for maintenance window.",
                      "old": "start minute for maintenance window"
                    }
                  },
                  {
                    "#name": "dayOfWeek",
                    "Description": {
                      "new": "Day of the week to be used for maintenance window.",
                      "old": "day of week for maintenance window"
                    }
                  }
                ]
              },
              {
                "#name": "sourceServerResourceId",
                "Description": {
                  "new": "Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.",
                  "old": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server"
                }
              },
              {
                "#name": "pointInTimeUTC",
                "Description": {
                  "new": "Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.",
                  "old": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'."
                }
              },
              {
                "#name": "availabilityZone",
                "Description": {
                  "new": "Availability zone of a flexible server.",
                  "old": "availability zone information of the server."
                }
              },
              {
                "#name": "replicationRole",
                "Description": {
                  "new": "Role of the server in a replication set.",
                  "old": "Replication role of the server"
                }
              },
              {
                "#name": "replicaCapacity",
                "Description": {
                  "new": "Maximum number of read replicas allowed for a flexible server.",
                  "old": "Replicas allowed for a server."
                }
              },
              {
                "#name": "replica",
                "Description": {
                  "new": "Read replica properties of a flexible server. Required only in case that you want to promote a server.",
                  "old": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server."
                },
                "$properties": [
                  {
                    "#name": "role",
                    "Description": {
                      "new": "Role of the server in a replication set.",
                      "old": "Used to indicate role of the server in replication set."
                    }
                  },
                  {
                    "#name": "capacity",
                    "Description": {
                      "new": "Maximum number of read replicas allowed for a flexible server.",
                      "old": "Replicas allowed for a server."
                    }
                  },
                  {
                    "#name": "replicationState",
                    "Description": {
                      "new": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible  values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating",
                      "old": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring"
                    }
                  },
                  {
                    "#name": "promoteMode",
                    "Description": {
                      "new": "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.",
                      "old": "Sets the promote mode for a replica server. This is a write only property."
                    }
                  },
                  {
                    "#name": "promoteOption",
                    "Description": {
                      "new": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.",
                      "old": "Sets the promote options for a replica server. This is a write only property."
                    }
                  }
                ]
              },
              {
                "#name": "createMode",
                "Description": {
                  "new": "Creation mode of a new flexible server.",
                  "old": "The mode to create a new PostgreSQL server."
                }
              },
              {
                "#name": "privateEndpointConnections",
                "Description": {
                  "new": "List of private endpoint connections associated with the specified flexible server.",
                  "old": "List of private endpoint connections associated with the specified resource."
                }
              },
              {
                "#name": "cluster",
                "Description": {
                  "new": "Cluster properties of a flexible server.",
                  "old": "Cluster properties of a server."
                },
                "$properties": [
                  {
                    "#name": "clusterSize",
                    "Description": {
                      "new": "Number of nodes assigned to the elastic cluster.",
                      "old": "The node count for the cluster."
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Flexible server.",
        "old": "Represents a server."
      },
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "Compute tier and size of a flexible server.",
            "old": "The SKU (pricing tier) of the server."
          },
          "$properties": [
            {
              "#name": "name",
              "Description": {
                "new": "Name by which is known a given compute size assigned to a flexible server.",
                "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
              }
            },
            {
              "#name": "tier",
              "Description": {
                "new": "Tier of the compute assigned to a flexible server.",
                "old": "The tier of the particular SKU, e.g. Burstable."
              }
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "User assigned managed identities assigned to the flexible server.",
            "old": "Describes the identity of the application."
          },
          "$properties": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "Map of user assigned managed identities.",
                "old": "represents user assigned identities map."
              }
            },
            {
              "#name": "principalId",
              "Description": {
                "new": "Identifier of the object of the service principal associated to the user assigned managed identity.",
                "old": "the identity principal Id of the server."
              }
            },
            {
              "#name": "type",
              "Description": {
                "new": "Types of identities associated with a flexible server.",
                "old": "the types of identities associated with this resource"
              }
            },
            {
              "#name": "tenantId",
              "Description": {
                "new": "Identifier of the tenant of a flexible server.",
                "old": "Tenant id of the server."
              }
            }
          ]
        },
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a flexible server.",
            "old": "Properties of the server."
          },
          "$properties": [
            {
              "#name": "administratorLogin",
              "Description": {
                "new": "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.",
                "old": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
              }
            },
            {
              "#name": "administratorLoginPassword",
              "Description": {
                "new": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.",
                "old": "The administrator login password (required for server creation)."
              }
            },
            {
              "#name": "version",
              "Description": {
                "new": "Major version of PostgreSQL database engine.",
                "old": "PostgreSQL Server version."
              }
            },
            {
              "#name": "minorVersion",
              "Description": {
                "new": "Minor version of PostgreSQL database engine.",
                "old": "The minor version of the server."
              }
            },
            {
              "#name": "state",
              "Description": {
                "new": "Possible states of a flexible server.",
                "old": "A state of a server that is visible to user."
              }
            },
            {
              "#name": "fullyQualifiedDomainName",
              "Description": {
                "new": "Fully qualified domain name of a flexible server.",
                "old": "The fully qualified domain name of a server."
              }
            },
            {
              "#name": "storage",
              "Description": {
                "new": "Storage properties of a flexible server.",
                "old": "Storage properties of a server."
              },
              "$properties": [
                {
                  "#name": "storageSizeGB",
                  "Description": {
                    "new": "Size of storage assigned to a flexible server.",
                    "old": "Max storage allowed for a server."
                  }
                },
                {
                  "#name": "autoGrow",
                  "Description": {
                    "new": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.",
                    "old": "Flag to enable / disable Storage Auto grow for flexible server."
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Storage tier of a flexible server.",
                    "old": "Name of storage tier for IOPS."
                  }
                },
                {
                  "#name": "iops",
                  "Description": {
                    "new": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                    "old": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                  }
                },
                {
                  "#name": "throughput",
                  "Description": {
                    "new": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                    "old": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.",
                    "old": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified"
                  }
                }
              ]
            },
            {
              "#name": "authConfig",
              "Description": {
                "new": "Authentication configuration properties of a flexible server.",
                "old": "AuthConfig properties of a server."
              },
              "$properties": [
                {
                  "#name": "activeDirectoryAuth",
                  "Description": {
                    "new": "Indicates if the server supports Microsoft Entra authentication.",
                    "old": "If Enabled, Microsoft Entra authentication is enabled."
                  }
                },
                {
                  "#name": "passwordAuth",
                  "Description": {
                    "new": "Indicates if the server supports password based authentication.",
                    "old": "If Enabled, Password authentication is enabled."
                  }
                },
                {
                  "#name": "tenantId",
                  "Description": {
                    "new": "Identifier of the tenant of the delegated resource.",
                    "old": "Tenant id of the server."
                  }
                }
              ]
            },
            {
              "#name": "dataEncryption",
              "Description": {
                "new": "Data encryption properties of a flexible server.",
                "old": "Data encryption properties of a server."
              },
              "$properties": [
                {
                  "#name": "primaryKeyURI",
                  "Description": {
                    "new": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server.",
                    "old": "URI for the key in keyvault for data encryption of the primary server."
                  }
                },
                {
                  "#name": "primaryUserAssignedIdentityId",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server.",
                    "old": "Resource Id for the User assigned identity to be used for data encryption of the primary server."
                  }
                },
                {
                  "#name": "geoBackupKeyURI",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                    "old": "URI for the key in keyvault for data encryption for geo-backup of server."
                  }
                },
                {
                  "#name": "geoBackupUserAssignedIdentityId",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                    "old": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Data encryption type used by a flexible server.",
                    "old": "Data encryption type to depict if it is System Managed vs Azure Key vault."
                  }
                },
                {
                  "#name": "primaryEncryptionKeyStatus",
                  "Description": {
                    "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.",
                    "old": "Primary encryption key status for Data encryption enabled server."
                  }
                },
                {
                  "#name": "geoBackupEncryptionKeyStatus",
                  "Description": {
                    "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.",
                    "old": "Geo-backup encryption key status for Data encryption enabled server."
                  }
                }
              ]
            },
            {
              "#name": "backup",
              "Description": {
                "new": "Backup properties of a flexible server.",
                "old": "Backup properties of a server."
              },
              "$properties": [
                {
                  "#name": "backupRetentionDays",
                  "Description": {
                    "new": "Backup retention days for the flexible server.",
                    "old": "Backup retention days for the server."
                  }
                },
                {
                  "#name": "geoRedundantBackup",
                  "Description": {
                    "new": "Indicates if the server is configured to create geographically redundant backups.",
                    "old": "A value indicating whether Geo-Redundant backup is enabled on the server."
                  }
                },
                {
                  "#name": "earliestRestoreDate",
                  "Description": {
                    "new": "Earliest restore point time (ISO8601 format) for a flexible server.",
                    "old": "The earliest restore point time (ISO8601 format) for server."
                  }
                }
              ]
            },
            {
              "#name": "network",
              "Description": {
                "new": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.",
                "old": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server."
              },
              "$properties": [
                {
                  "#name": "publicNetworkAccess",
                  "Description": {
                    "new": "Indicates if public network access is enabled or not.",
                    "old": "public network access is enabled or not"
                  }
                },
                {
                  "#name": "delegatedSubnetResourceId",
                  "Description": {
                    "new": "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.",
                    "old": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                  }
                },
                {
                  "#name": "privateDnsZoneArmResourceId",
                  "Description": {
                    "new": "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.",
                    "old": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                  }
                }
              ]
            },
            {
              "#name": "highAvailability",
              "Description": {
                "new": "High availability properties of a flexible server.",
                "old": "High availability properties of a server."
              },
              "$properties": [
                {
                  "#name": "mode",
                  "Description": {
                    "new": "High availability mode for a flexible server.",
                    "old": "The HA mode for the server."
                  }
                },
                {
                  "#name": "state",
                  "Description": {
                    "new": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.",
                    "old": "A state of a HA server that is visible to user."
                  }
                },
                {
                  "#name": "standbyAvailabilityZone",
                  "Description": {
                    "new": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.",
                    "old": "availability zone information of the standby."
                  }
                }
              ]
            },
            {
              "#name": "maintenanceWindow",
              "Description": {
                "new": "Maintenance window properties of a flexible server.",
                "old": "Maintenance window properties of a server."
              },
              "$properties": [
                {
                  "#name": "customWindow",
                  "Description": {
                    "new": "Indicates whether custom window is enabled or disabled.",
                    "old": "indicates whether custom window is enabled or disabled"
                  }
                },
                {
                  "#name": "startHour",
                  "Description": {
                    "new": "Start hour to be used for maintenance window.",
                    "old": "start hour for maintenance window"
                  }
                },
                {
                  "#name": "startMinute",
                  "Description": {
                    "new": "Start minute to be used for maintenance window.",
                    "old": "start minute for maintenance window"
                  }
                },
                {
                  "#name": "dayOfWeek",
                  "Description": {
                    "new": "Day of the week to be used for maintenance window.",
                    "old": "day of week for maintenance window"
                  }
                }
              ]
            },
            {
              "#name": "sourceServerResourceId",
              "Description": {
                "new": "Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.",
                "old": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server"
              }
            },
            {
              "#name": "pointInTimeUTC",
              "Description": {
                "new": "Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.",
                "old": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'."
              }
            },
            {
              "#name": "availabilityZone",
              "Description": {
                "new": "Availability zone of a flexible server.",
                "old": "availability zone information of the server."
              }
            },
            {
              "#name": "replicationRole",
              "Description": {
                "new": "Role of the server in a replication set.",
                "old": "Replication role of the server"
              }
            },
            {
              "#name": "replicaCapacity",
              "Description": {
                "new": "Maximum number of read replicas allowed for a flexible server.",
                "old": "Replicas allowed for a server."
              }
            },
            {
              "#name": "replica",
              "Description": {
                "new": "Read replica properties of a flexible server. Required only in case that you want to promote a server.",
                "old": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server."
              },
              "$properties": [
                {
                  "#name": "role",
                  "Description": {
                    "new": "Role of the server in a replication set.",
                    "old": "Used to indicate role of the server in replication set."
                  }
                },
                {
                  "#name": "capacity",
                  "Description": {
                    "new": "Maximum number of read replicas allowed for a flexible server.",
                    "old": "Replicas allowed for a server."
                  }
                },
                {
                  "#name": "replicationState",
                  "Description": {
                    "new": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible  values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating",
                    "old": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring"
                  }
                },
                {
                  "#name": "promoteMode",
                  "Description": {
                    "new": "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.",
                    "old": "Sets the promote mode for a replica server. This is a write only property."
                  }
                },
                {
                  "#name": "promoteOption",
                  "Description": {
                    "new": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.",
                    "old": "Sets the promote options for a replica server. This is a write only property."
                  }
                }
              ]
            },
            {
              "#name": "createMode",
              "Description": {
                "new": "Creation mode of a new flexible server.",
                "old": "The mode to create a new PostgreSQL server."
              }
            },
            {
              "#name": "privateEndpointConnections",
              "Description": {
                "new": "List of private endpoint connections associated with the specified flexible server.",
                "old": "List of private endpoint connections associated with the specified resource."
              }
            },
            {
              "#name": "cluster",
              "Description": {
                "new": "Cluster properties of a flexible server.",
                "old": "Cluster properties of a server."
              },
              "$properties": [
                {
                  "#name": "clusterSize",
                  "Description": {
                    "new": "Number of nodes assigned to the elastic cluster.",
                    "old": "The node count for the cluster."
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "201": {
      "Description": {
        "new": "Flexible server.",
        "old": "Represents a server."
      },
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "Compute tier and size of a flexible server.",
            "old": "The SKU (pricing tier) of the server."
          },
          "$properties": [
            {
              "#name": "name",
              "Description": {
                "new": "Name by which is known a given compute size assigned to a flexible server.",
                "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
              }
            },
            {
              "#name": "tier",
              "Description": {
                "new": "Tier of the compute assigned to a flexible server.",
                "old": "The tier of the particular SKU, e.g. Burstable."
              }
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "User assigned managed identities assigned to the flexible server.",
            "old": "Describes the identity of the application."
          },
          "$properties": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "Map of user assigned managed identities.",
                "old": "represents user assigned identities map."
              }
            },
            {
              "#name": "principalId",
              "Description": {
                "new": "Identifier of the object of the service principal associated to the user assigned managed identity.",
                "old": "the identity principal Id of the server."
              }
            },
            {
              "#name": "type",
              "Description": {
                "new": "Types of identities associated with a flexible server.",
                "old": "the types of identities associated with this resource"
              }
            },
            {
              "#name": "tenantId",
              "Description": {
                "new": "Identifier of the tenant of a flexible server.",
                "old": "Tenant id of the server."
              }
            }
          ]
        },
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a flexible server.",
            "old": "Properties of the server."
          },
          "$properties": [
            {
              "#name": "administratorLogin",
              "Description": {
                "new": "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.",
                "old": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
              }
            },
            {
              "#name": "administratorLoginPassword",
              "Description": {
                "new": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.",
                "old": "The administrator login password (required for server creation)."
              }
            },
            {
              "#name": "version",
              "Description": {
                "new": "Major version of PostgreSQL database engine.",
                "old": "PostgreSQL Server version."
              }
            },
            {
              "#name": "minorVersion",
              "Description": {
                "new": "Minor version of PostgreSQL database engine.",
                "old": "The minor version of the server."
              }
            },
            {
              "#name": "state",
              "Description": {
                "new": "Possible states of a flexible server.",
                "old": "A state of a server that is visible to user."
              }
            },
            {
              "#name": "fullyQualifiedDomainName",
              "Description": {
                "new": "Fully qualified domain name of a flexible server.",
                "old": "The fully qualified domain name of a server."
              }
            },
            {
              "#name": "storage",
              "Description": {
                "new": "Storage properties of a flexible server.",
                "old": "Storage properties of a server."
              },
              "$properties": [
                {
                  "#name": "storageSizeGB",
                  "Description": {
                    "new": "Size of storage assigned to a flexible server.",
                    "old": "Max storage allowed for a server."
                  }
                },
                {
                  "#name": "autoGrow",
                  "Description": {
                    "new": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.",
                    "old": "Flag to enable / disable Storage Auto grow for flexible server."
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Storage tier of a flexible server.",
                    "old": "Name of storage tier for IOPS."
                  }
                },
                {
                  "#name": "iops",
                  "Description": {
                    "new": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                    "old": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                  }
                },
                {
                  "#name": "throughput",
                  "Description": {
                    "new": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                    "old": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.",
                    "old": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified"
                  }
                }
              ]
            },
            {
              "#name": "authConfig",
              "Description": {
                "new": "Authentication configuration properties of a flexible server.",
                "old": "AuthConfig properties of a server."
              },
              "$properties": [
                {
                  "#name": "activeDirectoryAuth",
                  "Description": {
                    "new": "Indicates if the server supports Microsoft Entra authentication.",
                    "old": "If Enabled, Microsoft Entra authentication is enabled."
                  }
                },
                {
                  "#name": "passwordAuth",
                  "Description": {
                    "new": "Indicates if the server supports password based authentication.",
                    "old": "If Enabled, Password authentication is enabled."
                  }
                },
                {
                  "#name": "tenantId",
                  "Description": {
                    "new": "Identifier of the tenant of the delegated resource.",
                    "old": "Tenant id of the server."
                  }
                }
              ]
            },
            {
              "#name": "dataEncryption",
              "Description": {
                "new": "Data encryption properties of a flexible server.",
                "old": "Data encryption properties of a server."
              },
              "$properties": [
                {
                  "#name": "primaryKeyURI",
                  "Description": {
                    "new": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server.",
                    "old": "URI for the key in keyvault for data encryption of the primary server."
                  }
                },
                {
                  "#name": "primaryUserAssignedIdentityId",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server.",
                    "old": "Resource Id for the User assigned identity to be used for data encryption of the primary server."
                  }
                },
                {
                  "#name": "geoBackupKeyURI",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                    "old": "URI for the key in keyvault for data encryption for geo-backup of server."
                  }
                },
                {
                  "#name": "geoBackupUserAssignedIdentityId",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                    "old": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Data encryption type used by a flexible server.",
                    "old": "Data encryption type to depict if it is System Managed vs Azure Key vault."
                  }
                },
                {
                  "#name": "primaryEncryptionKeyStatus",
                  "Description": {
                    "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.",
                    "old": "Primary encryption key status for Data encryption enabled server."
                  }
                },
                {
                  "#name": "geoBackupEncryptionKeyStatus",
                  "Description": {
                    "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.",
                    "old": "Geo-backup encryption key status for Data encryption enabled server."
                  }
                }
              ]
            },
            {
              "#name": "backup",
              "Description": {
                "new": "Backup properties of a flexible server.",
                "old": "Backup properties of a server."
              },
              "$properties": [
                {
                  "#name": "backupRetentionDays",
                  "Description": {
                    "new": "Backup retention days for the flexible server.",
                    "old": "Backup retention days for the server."
                  }
                },
                {
                  "#name": "geoRedundantBackup",
                  "Description": {
                    "new": "Indicates if the server is configured to create geographically redundant backups.",
                    "old": "A value indicating whether Geo-Redundant backup is enabled on the server."
                  }
                },
                {
                  "#name": "earliestRestoreDate",
                  "Description": {
                    "new": "Earliest restore point time (ISO8601 format) for a flexible server.",
                    "old": "The earliest restore point time (ISO8601 format) for server."
                  }
                }
              ]
            },
            {
              "#name": "network",
              "Description": {
                "new": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.",
                "old": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server."
              },
              "$properties": [
                {
                  "#name": "publicNetworkAccess",
                  "Description": {
                    "new": "Indicates if public network access is enabled or not.",
                    "old": "public network access is enabled or not"
                  }
                },
                {
                  "#name": "delegatedSubnetResourceId",
                  "Description": {
                    "new": "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.",
                    "old": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                  }
                },
                {
                  "#name": "privateDnsZoneArmResourceId",
                  "Description": {
                    "new": "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.",
                    "old": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                  }
                }
              ]
            },
            {
              "#name": "highAvailability",
              "Description": {
                "new": "High availability properties of a flexible server.",
                "old": "High availability properties of a server."
              },
              "$properties": [
                {
                  "#name": "mode",
                  "Description": {
                    "new": "High availability mode for a flexible server.",
                    "old": "The HA mode for the server."
                  }
                },
                {
                  "#name": "state",
                  "Description": {
                    "new": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.",
                    "old": "A state of a HA server that is visible to user."
                  }
                },
                {
                  "#name": "standbyAvailabilityZone",
                  "Description": {
                    "new": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.",
                    "old": "availability zone information of the standby."
                  }
                }
              ]
            },
            {
              "#name": "maintenanceWindow",
              "Description": {
                "new": "Maintenance window properties of a flexible server.",
                "old": "Maintenance window properties of a server."
              },
              "$properties": [
                {
                  "#name": "customWindow",
                  "Description": {
                    "new": "Indicates whether custom window is enabled or disabled.",
                    "old": "indicates whether custom window is enabled or disabled"
                  }
                },
                {
                  "#name": "startHour",
                  "Description": {
                    "new": "Start hour to be used for maintenance window.",
                    "old": "start hour for maintenance window"
                  }
                },
                {
                  "#name": "startMinute",
                  "Description": {
                    "new": "Start minute to be used for maintenance window.",
                    "old": "start minute for maintenance window"
                  }
                },
                {
                  "#name": "dayOfWeek",
                  "Description": {
                    "new": "Day of the week to be used for maintenance window.",
                    "old": "day of week for maintenance window"
                  }
                }
              ]
            },
            {
              "#name": "sourceServerResourceId",
              "Description": {
                "new": "Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.",
                "old": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server"
              }
            },
            {
              "#name": "pointInTimeUTC",
              "Description": {
                "new": "Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.",
                "old": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'."
              }
            },
            {
              "#name": "availabilityZone",
              "Description": {
                "new": "Availability zone of a flexible server.",
                "old": "availability zone information of the server."
              }
            },
            {
              "#name": "replicationRole",
              "Description": {
                "new": "Role of the server in a replication set.",
                "old": "Replication role of the server"
              }
            },
            {
              "#name": "replicaCapacity",
              "Description": {
                "new": "Maximum number of read replicas allowed for a flexible server.",
                "old": "Replicas allowed for a server."
              }
            },
            {
              "#name": "replica",
              "Description": {
                "new": "Read replica properties of a flexible server. Required only in case that you want to promote a server.",
                "old": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server."
              },
              "$properties": [
                {
                  "#name": "role",
                  "Description": {
                    "new": "Role of the server in a replication set.",
                    "old": "Used to indicate role of the server in replication set."
                  }
                },
                {
                  "#name": "capacity",
                  "Description": {
                    "new": "Maximum number of read replicas allowed for a flexible server.",
                    "old": "Replicas allowed for a server."
                  }
                },
                {
                  "#name": "replicationState",
                  "Description": {
                    "new": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible  values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating",
                    "old": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring"
                  }
                },
                {
                  "#name": "promoteMode",
                  "Description": {
                    "new": "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.",
                    "old": "Sets the promote mode for a replica server. This is a write only property."
                  }
                },
                {
                  "#name": "promoteOption",
                  "Description": {
                    "new": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.",
                    "old": "Sets the promote options for a replica server. This is a write only property."
                  }
                }
              ]
            },
            {
              "#name": "createMode",
              "Description": {
                "new": "Creation mode of a new flexible server.",
                "old": "The mode to create a new PostgreSQL server."
              }
            },
            {
              "#name": "privateEndpointConnections",
              "Description": {
                "new": "List of private endpoint connections associated with the specified flexible server.",
                "old": "List of private endpoint connections associated with the specified resource."
              }
            },
            {
              "#name": "cluster",
              "Description": {
                "new": "Cluster properties of a flexible server.",
                "old": "Cluster properties of a server."
              },
              "$properties": [
                {
                  "#name": "clusterSize",
                  "Description": {
                    "new": "Number of nodes assigned to the elastic cluster.",
                    "old": "The node count for the cluster."
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

⚼ 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 flexible server or to update an existing flexible server. ,
Required: True ,
}
{
sku:
{
Description: Compute tier and size of a flexible server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a flexible server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a flexible server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the flexible 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 flexible server. ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a flexible server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a flexible 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: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a flexible server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a flexible server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a flexible server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a flexible server. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: 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 flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a flexible server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a flexible server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible 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 flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a flexible server. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a flexible server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a flexible server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a flexible 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 flexible server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a flexible server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone 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 flexible 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 flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a flexible server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a flexible 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 description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: 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: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new flexible server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified flexible 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 flexible server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Compute tier and size of a flexible server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a flexible server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a flexible server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the flexible 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 flexible server. ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a flexible server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a flexible 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: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a flexible server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a flexible server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a flexible server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a flexible server. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: 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 flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a flexible server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a flexible server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible 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 flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a flexible server. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a flexible server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a flexible server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a flexible 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 flexible server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a flexible server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone 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 flexible 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 flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a flexible server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a flexible 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 description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: 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: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new flexible server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified flexible 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 flexible server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Compute tier and size of a flexible server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a flexible server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a flexible server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the flexible 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 flexible server. ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a flexible server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a flexible 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: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a flexible server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a flexible server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a flexible server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a flexible server. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: 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 flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a flexible server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a flexible server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible 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 flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a flexible server. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a flexible server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a flexible server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a flexible 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 flexible server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a flexible server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone 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 flexible 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 flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a flexible server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a flexible 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 description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: 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: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new flexible server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified flexible 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 flexible server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Servers_Update",
  "Description": {
    "new": "Updates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.",
    "old": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition."
  },
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required to update a flexible server.",
        "old": "The required parameters for updating a server."
      },
      "$schema": {
        "$properties": [
          {
            "#name": "sku",
            "Description": {
              "new": "Compute tier and size of a flexible server.",
              "old": "The SKU (pricing tier) of the server."
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name by which is known a given compute size assigned to a flexible server.",
                  "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                }
              },
              {
                "#name": "tier",
                "Description": {
                  "new": "Tier of the compute assigned to a flexible server.",
                  "old": "The tier of the particular SKU, e.g. Burstable."
                }
              }
            ]
          },
          {
            "identity": [
              {
                "#name": "userAssignedIdentities",
                "Description": {
                  "new": "Map of user assigned managed identities.",
                  "old": "represents user assigned identities map."
                }
              },
              {
                "#name": "principalId",
                "Description": {
                  "new": "Identifier of the object of the service principal associated to the user assigned managed identity.",
                  "old": "the identity principal Id of the server."
                }
              },
              {
                "#name": "type",
                "Description": {
                  "new": "Types of identities associated with a flexible server.",
                  "old": "the types of identities associated with this resource"
                }
              },
              {
                "#name": "tenantId",
                "Description": {
                  "new": "Identifier of the tenant of a flexible server.",
                  "old": "Tenant id of the server."
                }
              }
            ]
          },
          {
            "properties": [
              {
                "#name": "administratorLogin",
                "Description": {
                  "new": "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.",
                  "old": "The administrator's login name of a server. Can only be specified when the server is trying to switch to password authentication and does not have default administrator login."
                }
              },
              {
                "#name": "administratorLoginPassword",
                "Description": {
                  "new": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.",
                  "old": "The password of the administrator login."
                }
              },
              {
                "#name": "version",
                "Description": {
                  "new": "Major version of PostgreSQL database engine.",
                  "old": "PostgreSQL Server version. Version 17 is currently not supported for MVU."
                }
              },
              {
                "#name": "storage",
                "Description": {
                  "new": "Storage properties of a flexible server.",
                  "old": "Storage properties of a server."
                },
                "$properties": [
                  {
                    "#name": "storageSizeGB",
                    "Description": {
                      "new": "Size of storage assigned to a flexible server.",
                      "old": "Max storage allowed for a server."
                    }
                  },
                  {
                    "#name": "autoGrow",
                    "Description": {
                      "new": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.",
                      "old": "Flag to enable / disable Storage Auto grow for flexible server."
                    }
                  },
                  {
                    "#name": "tier",
                    "Description": {
                      "new": "Storage tier of a flexible server.",
                      "old": "Name of storage tier for IOPS."
                    }
                  },
                  {
                    "#name": "iops",
                    "Description": {
                      "new": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                      "old": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                    }
                  },
                  {
                    "#name": "throughput",
                    "Description": {
                      "new": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                      "old": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                    }
                  },
                  {
                    "#name": "type",
                    "Description": {
                      "new": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.",
                      "old": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified"
                    }
                  }
                ]
              },
              {
                "#name": "backup",
                "Description": {
                  "new": "Backup properties of a flexible server.",
                  "old": "Backup properties of a server."
                },
                "$properties": [
                  {
                    "#name": "backupRetentionDays",
                    "Description": {
                      "new": "Backup retention days for the flexible server.",
                      "old": "Backup retention days for the server."
                    }
                  },
                  {
                    "#name": "geoRedundantBackup",
                    "Description": {
                      "new": "Indicates if the server is configured to create geographically redundant backups.",
                      "old": "A value indicating whether Geo-Redundant backup is enabled on the server."
                    }
                  },
                  {
                    "#name": "earliestRestoreDate",
                    "Description": {
                      "new": "Earliest restore point time (ISO8601 format) for a flexible server.",
                      "old": "The earliest restore point time (ISO8601 format) for server."
                    }
                  }
                ]
              },
              {
                "#name": "highAvailability",
                "Description": {
                  "new": "High availability properties of a flexible server.",
                  "old": "High availability properties of a server."
                },
                "$properties": [
                  {
                    "#name": "mode",
                    "Description": {
                      "new": "High availability mode for a flexible server.",
                      "old": "The HA mode for the server."
                    }
                  },
                  {
                    "#name": "state",
                    "Description": {
                      "new": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.",
                      "old": "A state of a HA server that is visible to user."
                    }
                  },
                  {
                    "#name": "standbyAvailabilityZone",
                    "Description": {
                      "new": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.",
                      "old": "availability zone information of the standby."
                    }
                  }
                ]
              },
              {
                "#name": "maintenanceWindow",
                "Description": {
                  "new": "Maintenance window properties of a flexible server.",
                  "old": "Maintenance window properties of a server."
                },
                "$properties": [
                  {
                    "#name": "customWindow",
                    "Description": {
                      "new": "Indicates whether custom window is enabled or disabled.",
                      "old": "indicates whether custom window is enabled or disabled"
                    }
                  },
                  {
                    "#name": "startHour",
                    "Description": {
                      "new": "Start hour to be used for maintenance window.",
                      "old": "start hour for maintenance window"
                    }
                  },
                  {
                    "#name": "startMinute",
                    "Description": {
                      "new": "Start minute to be used for maintenance window.",
                      "old": "start minute for maintenance window"
                    }
                  },
                  {
                    "#name": "dayOfWeek",
                    "Description": {
                      "new": "Day of the week to be used for maintenance window.",
                      "old": "day of week for maintenance window"
                    }
                  }
                ]
              },
              {
                "#name": "authConfig",
                "Description": {
                  "new": "Authentication configuration properties of a flexible server.",
                  "old": "AuthConfig properties of a server."
                },
                "$properties": [
                  {
                    "#name": "activeDirectoryAuth",
                    "Description": {
                      "new": "Indicates if the server supports Microsoft Entra authentication.",
                      "old": "If Enabled, Microsoft Entra authentication is enabled."
                    }
                  },
                  {
                    "#name": "passwordAuth",
                    "Description": {
                      "new": "Indicates if the server supports password based authentication.",
                      "old": "If Enabled, Password authentication is enabled."
                    }
                  },
                  {
                    "#name": "tenantId",
                    "Description": {
                      "new": "Identifier of the tenant of the delegated resource.",
                      "old": "Tenant id of the server."
                    }
                  }
                ]
              },
              {
                "#name": "dataEncryption",
                "Description": {
                  "new": "Data encryption properties of a flexible server.",
                  "old": "Data encryption properties of a server."
                },
                "$properties": [
                  {
                    "#name": "primaryKeyURI",
                    "Description": {
                      "new": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server.",
                      "old": "URI for the key in keyvault for data encryption of the primary server."
                    }
                  },
                  {
                    "#name": "primaryUserAssignedIdentityId",
                    "Description": {
                      "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server.",
                      "old": "Resource Id for the User assigned identity to be used for data encryption of the primary server."
                    }
                  },
                  {
                    "#name": "geoBackupKeyURI",
                    "Description": {
                      "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                      "old": "URI for the key in keyvault for data encryption for geo-backup of server."
                    }
                  },
                  {
                    "#name": "geoBackupUserAssignedIdentityId",
                    "Description": {
                      "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                      "old": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server."
                    }
                  },
                  {
                    "#name": "type",
                    "Description": {
                      "new": "Data encryption type used by a flexible server.",
                      "old": "Data encryption type to depict if it is System Managed vs Azure Key vault."
                    }
                  },
                  {
                    "#name": "primaryEncryptionKeyStatus",
                    "Description": {
                      "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.",
                      "old": "Primary encryption key status for Data encryption enabled server."
                    }
                  },
                  {
                    "#name": "geoBackupEncryptionKeyStatus",
                    "Description": {
                      "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.",
                      "old": "Geo-backup encryption key status for Data encryption enabled server."
                    }
                  }
                ]
              },
              {
                "#name": "createMode",
                "Description": {
                  "new": "Update mode of an existing flexible server.",
                  "old": "The mode to update a new PostgreSQL server."
                }
              },
              {
                "#name": "replicationRole",
                "Description": {
                  "new": "Role of the server in a replication set.",
                  "old": "Replication role of the server"
                }
              },
              {
                "#name": "replica",
                "Description": {
                  "new": "Read replica properties of a flexible server. Required only in case that you want to promote a server.",
                  "old": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server."
                },
                "$properties": [
                  {
                    "#name": "role",
                    "Description": {
                      "new": "Role of the server in a replication set.",
                      "old": "Used to indicate role of the server in replication set."
                    }
                  },
                  {
                    "#name": "capacity",
                    "Description": {
                      "new": "Maximum number of read replicas allowed for a flexible server.",
                      "old": "Replicas allowed for a server."
                    }
                  },
                  {
                    "#name": "replicationState",
                    "Description": {
                      "new": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible  values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating",
                      "old": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring"
                    }
                  },
                  {
                    "#name": "promoteMode",
                    "Description": {
                      "new": "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.",
                      "old": "Sets the promote mode for a replica server. This is a write only property."
                    }
                  },
                  {
                    "#name": "promoteOption",
                    "Description": {
                      "new": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.",
                      "old": "Sets the promote options for a replica server. This is a write only property."
                    }
                  }
                ]
              },
              {
                "#name": "network",
                "Description": {
                  "new": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.",
                  "old": "Network properties of a server. These are required to be passed only in case if server is a private access server."
                },
                "$properties": [
                  {
                    "#name": "publicNetworkAccess",
                    "Description": {
                      "new": "Indicates if public network access is enabled or not.",
                      "old": "public network access is enabled or not"
                    }
                  },
                  {
                    "#name": "delegatedSubnetResourceId",
                    "Description": {
                      "new": "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.",
                      "old": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                    }
                  },
                  {
                    "#name": "privateDnsZoneArmResourceId",
                    "Description": {
                      "new": "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.",
                      "old": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                    }
                  }
                ]
              },
              {
                "#name": "cluster",
                "Description": {
                  "new": "Cluster properties of a flexible server.",
                  "old": "Cluster properties of a server."
                },
                "$properties": [
                  {
                    "#name": "clusterSize",
                    "Description": {
                      "new": "Number of nodes assigned to the elastic cluster.",
                      "old": "The node count for the cluster."
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Flexible server.",
        "old": "Represents a server."
      },
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "Compute tier and size of a flexible server.",
            "old": "The SKU (pricing tier) of the server."
          },
          "$properties": [
            {
              "#name": "name",
              "Description": {
                "new": "Name by which is known a given compute size assigned to a flexible server.",
                "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
              }
            },
            {
              "#name": "tier",
              "Description": {
                "new": "Tier of the compute assigned to a flexible server.",
                "old": "The tier of the particular SKU, e.g. Burstable."
              }
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "User assigned managed identities assigned to the flexible server.",
            "old": "Describes the identity of the application."
          },
          "$properties": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "Map of user assigned managed identities.",
                "old": "represents user assigned identities map."
              }
            },
            {
              "#name": "principalId",
              "Description": {
                "new": "Identifier of the object of the service principal associated to the user assigned managed identity.",
                "old": "the identity principal Id of the server."
              }
            },
            {
              "#name": "type",
              "Description": {
                "new": "Types of identities associated with a flexible server.",
                "old": "the types of identities associated with this resource"
              }
            },
            {
              "#name": "tenantId",
              "Description": {
                "new": "Identifier of the tenant of a flexible server.",
                "old": "Tenant id of the server."
              }
            }
          ]
        },
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a flexible server.",
            "old": "Properties of the server."
          },
          "$properties": [
            {
              "#name": "administratorLogin",
              "Description": {
                "new": "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.",
                "old": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
              }
            },
            {
              "#name": "administratorLoginPassword",
              "Description": {
                "new": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.",
                "old": "The administrator login password (required for server creation)."
              }
            },
            {
              "#name": "version",
              "Description": {
                "new": "Major version of PostgreSQL database engine.",
                "old": "PostgreSQL Server version."
              }
            },
            {
              "#name": "minorVersion",
              "Description": {
                "new": "Minor version of PostgreSQL database engine.",
                "old": "The minor version of the server."
              }
            },
            {
              "#name": "state",
              "Description": {
                "new": "Possible states of a flexible server.",
                "old": "A state of a server that is visible to user."
              }
            },
            {
              "#name": "fullyQualifiedDomainName",
              "Description": {
                "new": "Fully qualified domain name of a flexible server.",
                "old": "The fully qualified domain name of a server."
              }
            },
            {
              "#name": "storage",
              "Description": {
                "new": "Storage properties of a flexible server.",
                "old": "Storage properties of a server."
              },
              "$properties": [
                {
                  "#name": "storageSizeGB",
                  "Description": {
                    "new": "Size of storage assigned to a flexible server.",
                    "old": "Max storage allowed for a server."
                  }
                },
                {
                  "#name": "autoGrow",
                  "Description": {
                    "new": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.",
                    "old": "Flag to enable / disable Storage Auto grow for flexible server."
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Storage tier of a flexible server.",
                    "old": "Name of storage tier for IOPS."
                  }
                },
                {
                  "#name": "iops",
                  "Description": {
                    "new": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                    "old": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                  }
                },
                {
                  "#name": "throughput",
                  "Description": {
                    "new": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                    "old": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.",
                    "old": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified"
                  }
                }
              ]
            },
            {
              "#name": "authConfig",
              "Description": {
                "new": "Authentication configuration properties of a flexible server.",
                "old": "AuthConfig properties of a server."
              },
              "$properties": [
                {
                  "#name": "activeDirectoryAuth",
                  "Description": {
                    "new": "Indicates if the server supports Microsoft Entra authentication.",
                    "old": "If Enabled, Microsoft Entra authentication is enabled."
                  }
                },
                {
                  "#name": "passwordAuth",
                  "Description": {
                    "new": "Indicates if the server supports password based authentication.",
                    "old": "If Enabled, Password authentication is enabled."
                  }
                },
                {
                  "#name": "tenantId",
                  "Description": {
                    "new": "Identifier of the tenant of the delegated resource.",
                    "old": "Tenant id of the server."
                  }
                }
              ]
            },
            {
              "#name": "dataEncryption",
              "Description": {
                "new": "Data encryption properties of a flexible server.",
                "old": "Data encryption properties of a server."
              },
              "$properties": [
                {
                  "#name": "primaryKeyURI",
                  "Description": {
                    "new": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server.",
                    "old": "URI for the key in keyvault for data encryption of the primary server."
                  }
                },
                {
                  "#name": "primaryUserAssignedIdentityId",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server.",
                    "old": "Resource Id for the User assigned identity to be used for data encryption of the primary server."
                  }
                },
                {
                  "#name": "geoBackupKeyURI",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                    "old": "URI for the key in keyvault for data encryption for geo-backup of server."
                  }
                },
                {
                  "#name": "geoBackupUserAssignedIdentityId",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                    "old": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Data encryption type used by a flexible server.",
                    "old": "Data encryption type to depict if it is System Managed vs Azure Key vault."
                  }
                },
                {
                  "#name": "primaryEncryptionKeyStatus",
                  "Description": {
                    "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.",
                    "old": "Primary encryption key status for Data encryption enabled server."
                  }
                },
                {
                  "#name": "geoBackupEncryptionKeyStatus",
                  "Description": {
                    "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.",
                    "old": "Geo-backup encryption key status for Data encryption enabled server."
                  }
                }
              ]
            },
            {
              "#name": "backup",
              "Description": {
                "new": "Backup properties of a flexible server.",
                "old": "Backup properties of a server."
              },
              "$properties": [
                {
                  "#name": "backupRetentionDays",
                  "Description": {
                    "new": "Backup retention days for the flexible server.",
                    "old": "Backup retention days for the server."
                  }
                },
                {
                  "#name": "geoRedundantBackup",
                  "Description": {
                    "new": "Indicates if the server is configured to create geographically redundant backups.",
                    "old": "A value indicating whether Geo-Redundant backup is enabled on the server."
                  }
                },
                {
                  "#name": "earliestRestoreDate",
                  "Description": {
                    "new": "Earliest restore point time (ISO8601 format) for a flexible server.",
                    "old": "The earliest restore point time (ISO8601 format) for server."
                  }
                }
              ]
            },
            {
              "#name": "network",
              "Description": {
                "new": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.",
                "old": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server."
              },
              "$properties": [
                {
                  "#name": "publicNetworkAccess",
                  "Description": {
                    "new": "Indicates if public network access is enabled or not.",
                    "old": "public network access is enabled or not"
                  }
                },
                {
                  "#name": "delegatedSubnetResourceId",
                  "Description": {
                    "new": "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.",
                    "old": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                  }
                },
                {
                  "#name": "privateDnsZoneArmResourceId",
                  "Description": {
                    "new": "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.",
                    "old": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                  }
                }
              ]
            },
            {
              "#name": "highAvailability",
              "Description": {
                "new": "High availability properties of a flexible server.",
                "old": "High availability properties of a server."
              },
              "$properties": [
                {
                  "#name": "mode",
                  "Description": {
                    "new": "High availability mode for a flexible server.",
                    "old": "The HA mode for the server."
                  }
                },
                {
                  "#name": "state",
                  "Description": {
                    "new": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.",
                    "old": "A state of a HA server that is visible to user."
                  }
                },
                {
                  "#name": "standbyAvailabilityZone",
                  "Description": {
                    "new": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.",
                    "old": "availability zone information of the standby."
                  }
                }
              ]
            },
            {
              "#name": "maintenanceWindow",
              "Description": {
                "new": "Maintenance window properties of a flexible server.",
                "old": "Maintenance window properties of a server."
              },
              "$properties": [
                {
                  "#name": "customWindow",
                  "Description": {
                    "new": "Indicates whether custom window is enabled or disabled.",
                    "old": "indicates whether custom window is enabled or disabled"
                  }
                },
                {
                  "#name": "startHour",
                  "Description": {
                    "new": "Start hour to be used for maintenance window.",
                    "old": "start hour for maintenance window"
                  }
                },
                {
                  "#name": "startMinute",
                  "Description": {
                    "new": "Start minute to be used for maintenance window.",
                    "old": "start minute for maintenance window"
                  }
                },
                {
                  "#name": "dayOfWeek",
                  "Description": {
                    "new": "Day of the week to be used for maintenance window.",
                    "old": "day of week for maintenance window"
                  }
                }
              ]
            },
            {
              "#name": "sourceServerResourceId",
              "Description": {
                "new": "Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.",
                "old": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server"
              }
            },
            {
              "#name": "pointInTimeUTC",
              "Description": {
                "new": "Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.",
                "old": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'."
              }
            },
            {
              "#name": "availabilityZone",
              "Description": {
                "new": "Availability zone of a flexible server.",
                "old": "availability zone information of the server."
              }
            },
            {
              "#name": "replicationRole",
              "Description": {
                "new": "Role of the server in a replication set.",
                "old": "Replication role of the server"
              }
            },
            {
              "#name": "replicaCapacity",
              "Description": {
                "new": "Maximum number of read replicas allowed for a flexible server.",
                "old": "Replicas allowed for a server."
              }
            },
            {
              "#name": "replica",
              "Description": {
                "new": "Read replica properties of a flexible server. Required only in case that you want to promote a server.",
                "old": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server."
              },
              "$properties": [
                {
                  "#name": "role",
                  "Description": {
                    "new": "Role of the server in a replication set.",
                    "old": "Used to indicate role of the server in replication set."
                  }
                },
                {
                  "#name": "capacity",
                  "Description": {
                    "new": "Maximum number of read replicas allowed for a flexible server.",
                    "old": "Replicas allowed for a server."
                  }
                },
                {
                  "#name": "replicationState",
                  "Description": {
                    "new": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible  values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating",
                    "old": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring"
                  }
                },
                {
                  "#name": "promoteMode",
                  "Description": {
                    "new": "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.",
                    "old": "Sets the promote mode for a replica server. This is a write only property."
                  }
                },
                {
                  "#name": "promoteOption",
                  "Description": {
                    "new": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.",
                    "old": "Sets the promote options for a replica server. This is a write only property."
                  }
                }
              ]
            },
            {
              "#name": "createMode",
              "Description": {
                "new": "Creation mode of a new flexible server.",
                "old": "The mode to create a new PostgreSQL server."
              }
            },
            {
              "#name": "privateEndpointConnections",
              "Description": {
                "new": "List of private endpoint connections associated with the specified flexible server.",
                "old": "List of private endpoint connections associated with the specified resource."
              }
            },
            {
              "#name": "cluster",
              "Description": {
                "new": "Cluster properties of a flexible server.",
                "old": "Cluster properties of a server."
              },
              "$properties": [
                {
                  "#name": "clusterSize",
                  "Description": {
                    "new": "Number of nodes assigned to the elastic cluster.",
                    "old": "The node count for the cluster."
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

⚼ 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 flexible server. ,
Required: True ,
}
{
sku:
{
Description: Compute tier and size of a flexible server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a flexible server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a flexible server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: Describes the identity of the application. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: 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 flexible server. ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a flexible 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: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage properties of a flexible server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a flexible server. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: 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 flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a flexible server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a flexible server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
highAvailability:
{
Description: High availability properties of a flexible server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a flexible server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone 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 flexible 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 flexible server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a flexible server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible 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 flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a flexible server. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Update mode of an existing flexible server. ,
Enum:
{
Default: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replica:
{
Description: Read replica properties of a flexible 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 description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: 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: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
network:
{
Description: Network properties of a flexible 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 flexible server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Compute tier and size of a flexible server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a flexible server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a flexible server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the flexible 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 flexible server. ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a flexible server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a flexible 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: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a flexible server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a flexible server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a flexible server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a flexible server. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: 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 flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a flexible server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a flexible server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible 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 flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a flexible server. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a flexible server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a flexible server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a flexible 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 flexible server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a flexible server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone 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 flexible 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 flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a flexible server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a flexible 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 description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: 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: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new flexible server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified flexible 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 flexible server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Delete (updated)
Description :  Deletes or drops an existing flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Delete",
  "Description": {
    "new": "Deletes or drops an existing flexible server.",
    "old": "Deletes a server."
  }
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Servers_Get",
  "Description": {
    "new": "Gets information about an existing flexible server.",
    "old": "Gets information about a server."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Flexible server.",
        "old": "Represents a server."
      },
      "$properties": [
        {
          "#name": "sku",
          "Description": {
            "new": "Compute tier and size of a flexible server.",
            "old": "The SKU (pricing tier) of the server."
          },
          "$properties": [
            {
              "#name": "name",
              "Description": {
                "new": "Name by which is known a given compute size assigned to a flexible server.",
                "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
              }
            },
            {
              "#name": "tier",
              "Description": {
                "new": "Tier of the compute assigned to a flexible server.",
                "old": "The tier of the particular SKU, e.g. Burstable."
              }
            }
          ]
        },
        {
          "#name": "identity",
          "Description": {
            "new": "User assigned managed identities assigned to the flexible server.",
            "old": "Describes the identity of the application."
          },
          "$properties": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "Map of user assigned managed identities.",
                "old": "represents user assigned identities map."
              }
            },
            {
              "#name": "principalId",
              "Description": {
                "new": "Identifier of the object of the service principal associated to the user assigned managed identity.",
                "old": "the identity principal Id of the server."
              }
            },
            {
              "#name": "type",
              "Description": {
                "new": "Types of identities associated with a flexible server.",
                "old": "the types of identities associated with this resource"
              }
            },
            {
              "#name": "tenantId",
              "Description": {
                "new": "Identifier of the tenant of a flexible server.",
                "old": "Tenant id of the server."
              }
            }
          ]
        },
        {
          "#name": "properties",
          "Description": {
            "new": "Properties of a flexible server.",
            "old": "Properties of the server."
          },
          "$properties": [
            {
              "#name": "administratorLogin",
              "Description": {
                "new": "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.",
                "old": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
              }
            },
            {
              "#name": "administratorLoginPassword",
              "Description": {
                "new": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.",
                "old": "The administrator login password (required for server creation)."
              }
            },
            {
              "#name": "version",
              "Description": {
                "new": "Major version of PostgreSQL database engine.",
                "old": "PostgreSQL Server version."
              }
            },
            {
              "#name": "minorVersion",
              "Description": {
                "new": "Minor version of PostgreSQL database engine.",
                "old": "The minor version of the server."
              }
            },
            {
              "#name": "state",
              "Description": {
                "new": "Possible states of a flexible server.",
                "old": "A state of a server that is visible to user."
              }
            },
            {
              "#name": "fullyQualifiedDomainName",
              "Description": {
                "new": "Fully qualified domain name of a flexible server.",
                "old": "The fully qualified domain name of a server."
              }
            },
            {
              "#name": "storage",
              "Description": {
                "new": "Storage properties of a flexible server.",
                "old": "Storage properties of a server."
              },
              "$properties": [
                {
                  "#name": "storageSizeGB",
                  "Description": {
                    "new": "Size of storage assigned to a flexible server.",
                    "old": "Max storage allowed for a server."
                  }
                },
                {
                  "#name": "autoGrow",
                  "Description": {
                    "new": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.",
                    "old": "Flag to enable / disable Storage Auto grow for flexible server."
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Storage tier of a flexible server.",
                    "old": "Name of storage tier for IOPS."
                  }
                },
                {
                  "#name": "iops",
                  "Description": {
                    "new": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                    "old": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                  }
                },
                {
                  "#name": "throughput",
                  "Description": {
                    "new": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                    "old": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.",
                    "old": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified"
                  }
                }
              ]
            },
            {
              "#name": "authConfig",
              "Description": {
                "new": "Authentication configuration properties of a flexible server.",
                "old": "AuthConfig properties of a server."
              },
              "$properties": [
                {
                  "#name": "activeDirectoryAuth",
                  "Description": {
                    "new": "Indicates if the server supports Microsoft Entra authentication.",
                    "old": "If Enabled, Microsoft Entra authentication is enabled."
                  }
                },
                {
                  "#name": "passwordAuth",
                  "Description": {
                    "new": "Indicates if the server supports password based authentication.",
                    "old": "If Enabled, Password authentication is enabled."
                  }
                },
                {
                  "#name": "tenantId",
                  "Description": {
                    "new": "Identifier of the tenant of the delegated resource.",
                    "old": "Tenant id of the server."
                  }
                }
              ]
            },
            {
              "#name": "dataEncryption",
              "Description": {
                "new": "Data encryption properties of a flexible server.",
                "old": "Data encryption properties of a server."
              },
              "$properties": [
                {
                  "#name": "primaryKeyURI",
                  "Description": {
                    "new": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server.",
                    "old": "URI for the key in keyvault for data encryption of the primary server."
                  }
                },
                {
                  "#name": "primaryUserAssignedIdentityId",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server.",
                    "old": "Resource Id for the User assigned identity to be used for data encryption of the primary server."
                  }
                },
                {
                  "#name": "geoBackupKeyURI",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                    "old": "URI for the key in keyvault for data encryption for geo-backup of server."
                  }
                },
                {
                  "#name": "geoBackupUserAssignedIdentityId",
                  "Description": {
                    "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                    "old": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Data encryption type used by a flexible server.",
                    "old": "Data encryption type to depict if it is System Managed vs Azure Key vault."
                  }
                },
                {
                  "#name": "primaryEncryptionKeyStatus",
                  "Description": {
                    "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.",
                    "old": "Primary encryption key status for Data encryption enabled server."
                  }
                },
                {
                  "#name": "geoBackupEncryptionKeyStatus",
                  "Description": {
                    "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.",
                    "old": "Geo-backup encryption key status for Data encryption enabled server."
                  }
                }
              ]
            },
            {
              "#name": "backup",
              "Description": {
                "new": "Backup properties of a flexible server.",
                "old": "Backup properties of a server."
              },
              "$properties": [
                {
                  "#name": "backupRetentionDays",
                  "Description": {
                    "new": "Backup retention days for the flexible server.",
                    "old": "Backup retention days for the server."
                  }
                },
                {
                  "#name": "geoRedundantBackup",
                  "Description": {
                    "new": "Indicates if the server is configured to create geographically redundant backups.",
                    "old": "A value indicating whether Geo-Redundant backup is enabled on the server."
                  }
                },
                {
                  "#name": "earliestRestoreDate",
                  "Description": {
                    "new": "Earliest restore point time (ISO8601 format) for a flexible server.",
                    "old": "The earliest restore point time (ISO8601 format) for server."
                  }
                }
              ]
            },
            {
              "#name": "network",
              "Description": {
                "new": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.",
                "old": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server."
              },
              "$properties": [
                {
                  "#name": "publicNetworkAccess",
                  "Description": {
                    "new": "Indicates if public network access is enabled or not.",
                    "old": "public network access is enabled or not"
                  }
                },
                {
                  "#name": "delegatedSubnetResourceId",
                  "Description": {
                    "new": "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.",
                    "old": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                  }
                },
                {
                  "#name": "privateDnsZoneArmResourceId",
                  "Description": {
                    "new": "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.",
                    "old": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                  }
                }
              ]
            },
            {
              "#name": "highAvailability",
              "Description": {
                "new": "High availability properties of a flexible server.",
                "old": "High availability properties of a server."
              },
              "$properties": [
                {
                  "#name": "mode",
                  "Description": {
                    "new": "High availability mode for a flexible server.",
                    "old": "The HA mode for the server."
                  }
                },
                {
                  "#name": "state",
                  "Description": {
                    "new": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.",
                    "old": "A state of a HA server that is visible to user."
                  }
                },
                {
                  "#name": "standbyAvailabilityZone",
                  "Description": {
                    "new": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.",
                    "old": "availability zone information of the standby."
                  }
                }
              ]
            },
            {
              "#name": "maintenanceWindow",
              "Description": {
                "new": "Maintenance window properties of a flexible server.",
                "old": "Maintenance window properties of a server."
              },
              "$properties": [
                {
                  "#name": "customWindow",
                  "Description": {
                    "new": "Indicates whether custom window is enabled or disabled.",
                    "old": "indicates whether custom window is enabled or disabled"
                  }
                },
                {
                  "#name": "startHour",
                  "Description": {
                    "new": "Start hour to be used for maintenance window.",
                    "old": "start hour for maintenance window"
                  }
                },
                {
                  "#name": "startMinute",
                  "Description": {
                    "new": "Start minute to be used for maintenance window.",
                    "old": "start minute for maintenance window"
                  }
                },
                {
                  "#name": "dayOfWeek",
                  "Description": {
                    "new": "Day of the week to be used for maintenance window.",
                    "old": "day of week for maintenance window"
                  }
                }
              ]
            },
            {
              "#name": "sourceServerResourceId",
              "Description": {
                "new": "Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.",
                "old": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server"
              }
            },
            {
              "#name": "pointInTimeUTC",
              "Description": {
                "new": "Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.",
                "old": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'."
              }
            },
            {
              "#name": "availabilityZone",
              "Description": {
                "new": "Availability zone of a flexible server.",
                "old": "availability zone information of the server."
              }
            },
            {
              "#name": "replicationRole",
              "Description": {
                "new": "Role of the server in a replication set.",
                "old": "Replication role of the server"
              }
            },
            {
              "#name": "replicaCapacity",
              "Description": {
                "new": "Maximum number of read replicas allowed for a flexible server.",
                "old": "Replicas allowed for a server."
              }
            },
            {
              "#name": "replica",
              "Description": {
                "new": "Read replica properties of a flexible server. Required only in case that you want to promote a server.",
                "old": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server."
              },
              "$properties": [
                {
                  "#name": "role",
                  "Description": {
                    "new": "Role of the server in a replication set.",
                    "old": "Used to indicate role of the server in replication set."
                  }
                },
                {
                  "#name": "capacity",
                  "Description": {
                    "new": "Maximum number of read replicas allowed for a flexible server.",
                    "old": "Replicas allowed for a server."
                  }
                },
                {
                  "#name": "replicationState",
                  "Description": {
                    "new": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible  values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating",
                    "old": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring"
                  }
                },
                {
                  "#name": "promoteMode",
                  "Description": {
                    "new": "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.",
                    "old": "Sets the promote mode for a replica server. This is a write only property."
                  }
                },
                {
                  "#name": "promoteOption",
                  "Description": {
                    "new": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.",
                    "old": "Sets the promote options for a replica server. This is a write only property."
                  }
                }
              ]
            },
            {
              "#name": "createMode",
              "Description": {
                "new": "Creation mode of a new flexible server.",
                "old": "The mode to create a new PostgreSQL server."
              }
            },
            {
              "#name": "privateEndpointConnections",
              "Description": {
                "new": "List of private endpoint connections associated with the specified flexible server.",
                "old": "List of private endpoint connections associated with the specified resource."
              }
            },
            {
              "#name": "cluster",
              "Description": {
                "new": "Cluster properties of a flexible server.",
                "old": "Cluster properties of a server."
              },
              "$properties": [
                {
                  "#name": "clusterSize",
                  "Description": {
                    "new": "Number of nodes assigned to the elastic cluster.",
                    "old": "The node count for the cluster."
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

⚼ 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 flexible server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a flexible server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a flexible server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the flexible 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 flexible server. ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a flexible server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a flexible 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: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a flexible server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a flexible server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a flexible server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a flexible server. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: 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 flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a flexible server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a flexible server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible 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 flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a flexible server. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a flexible server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a flexible server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a flexible 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 flexible server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a flexible server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone 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 flexible 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 flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a flexible server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a flexible 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 description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: 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: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new flexible server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified flexible 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 flexible server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Servers_ListByResourceGroup",
  "Description": {
    "new": "Lists all flexible servers in a resource group.",
    "old": "List all the servers in a given resource group."
  },
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "Flexible server.",
            "old": "Represents a server."
          },
          "$properties": [
            {
              "#name": "sku",
              "Description": {
                "new": "Compute tier and size of a flexible server.",
                "old": "The SKU (pricing tier) of the server."
              },
              "$properties": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "Name by which is known a given compute size assigned to a flexible server.",
                    "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Tier of the compute assigned to a flexible server.",
                    "old": "The tier of the particular SKU, e.g. Burstable."
                  }
                }
              ]
            },
            {
              "#name": "identity",
              "Description": {
                "new": "User assigned managed identities assigned to the flexible server.",
                "old": "Describes the identity of the application."
              },
              "$properties": [
                {
                  "#name": "userAssignedIdentities",
                  "Description": {
                    "new": "Map of user assigned managed identities.",
                    "old": "represents user assigned identities map."
                  }
                },
                {
                  "#name": "principalId",
                  "Description": {
                    "new": "Identifier of the object of the service principal associated to the user assigned managed identity.",
                    "old": "the identity principal Id of the server."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Types of identities associated with a flexible server.",
                    "old": "the types of identities associated with this resource"
                  }
                },
                {
                  "#name": "tenantId",
                  "Description": {
                    "new": "Identifier of the tenant of a flexible server.",
                    "old": "Tenant id of the server."
                  }
                }
              ]
            },
            {
              "#name": "properties",
              "Description": {
                "new": "Properties of a flexible server.",
                "old": "Properties of the server."
              },
              "$properties": [
                {
                  "#name": "administratorLogin",
                  "Description": {
                    "new": "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.",
                    "old": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
                  }
                },
                {
                  "#name": "administratorLoginPassword",
                  "Description": {
                    "new": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.",
                    "old": "The administrator login password (required for server creation)."
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Major version of PostgreSQL database engine.",
                    "old": "PostgreSQL Server version."
                  }
                },
                {
                  "#name": "minorVersion",
                  "Description": {
                    "new": "Minor version of PostgreSQL database engine.",
                    "old": "The minor version of the server."
                  }
                },
                {
                  "#name": "state",
                  "Description": {
                    "new": "Possible states of a flexible server.",
                    "old": "A state of a server that is visible to user."
                  }
                },
                {
                  "#name": "fullyQualifiedDomainName",
                  "Description": {
                    "new": "Fully qualified domain name of a flexible server.",
                    "old": "The fully qualified domain name of a server."
                  }
                },
                {
                  "#name": "storage",
                  "Description": {
                    "new": "Storage properties of a flexible server.",
                    "old": "Storage properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "storageSizeGB",
                      "Description": {
                        "new": "Size of storage assigned to a flexible server.",
                        "old": "Max storage allowed for a server."
                      }
                    },
                    {
                      "#name": "autoGrow",
                      "Description": {
                        "new": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.",
                        "old": "Flag to enable / disable Storage Auto grow for flexible server."
                      }
                    },
                    {
                      "#name": "tier",
                      "Description": {
                        "new": "Storage tier of a flexible server.",
                        "old": "Name of storage tier for IOPS."
                      }
                    },
                    {
                      "#name": "iops",
                      "Description": {
                        "new": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                        "old": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                      }
                    },
                    {
                      "#name": "throughput",
                      "Description": {
                        "new": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                        "old": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                      }
                    },
                    {
                      "#name": "type",
                      "Description": {
                        "new": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.",
                        "old": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified"
                      }
                    }
                  ]
                },
                {
                  "#name": "authConfig",
                  "Description": {
                    "new": "Authentication configuration properties of a flexible server.",
                    "old": "AuthConfig properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "activeDirectoryAuth",
                      "Description": {
                        "new": "Indicates if the server supports Microsoft Entra authentication.",
                        "old": "If Enabled, Microsoft Entra authentication is enabled."
                      }
                    },
                    {
                      "#name": "passwordAuth",
                      "Description": {
                        "new": "Indicates if the server supports password based authentication.",
                        "old": "If Enabled, Password authentication is enabled."
                      }
                    },
                    {
                      "#name": "tenantId",
                      "Description": {
                        "new": "Identifier of the tenant of the delegated resource.",
                        "old": "Tenant id of the server."
                      }
                    }
                  ]
                },
                {
                  "#name": "dataEncryption",
                  "Description": {
                    "new": "Data encryption properties of a flexible server.",
                    "old": "Data encryption properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "primaryKeyURI",
                      "Description": {
                        "new": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server.",
                        "old": "URI for the key in keyvault for data encryption of the primary server."
                      }
                    },
                    {
                      "#name": "primaryUserAssignedIdentityId",
                      "Description": {
                        "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server.",
                        "old": "Resource Id for the User assigned identity to be used for data encryption of the primary server."
                      }
                    },
                    {
                      "#name": "geoBackupKeyURI",
                      "Description": {
                        "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                        "old": "URI for the key in keyvault for data encryption for geo-backup of server."
                      }
                    },
                    {
                      "#name": "geoBackupUserAssignedIdentityId",
                      "Description": {
                        "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                        "old": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server."
                      }
                    },
                    {
                      "#name": "type",
                      "Description": {
                        "new": "Data encryption type used by a flexible server.",
                        "old": "Data encryption type to depict if it is System Managed vs Azure Key vault."
                      }
                    },
                    {
                      "#name": "primaryEncryptionKeyStatus",
                      "Description": {
                        "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.",
                        "old": "Primary encryption key status for Data encryption enabled server."
                      }
                    },
                    {
                      "#name": "geoBackupEncryptionKeyStatus",
                      "Description": {
                        "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.",
                        "old": "Geo-backup encryption key status for Data encryption enabled server."
                      }
                    }
                  ]
                },
                {
                  "#name": "backup",
                  "Description": {
                    "new": "Backup properties of a flexible server.",
                    "old": "Backup properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "backupRetentionDays",
                      "Description": {
                        "new": "Backup retention days for the flexible server.",
                        "old": "Backup retention days for the server."
                      }
                    },
                    {
                      "#name": "geoRedundantBackup",
                      "Description": {
                        "new": "Indicates if the server is configured to create geographically redundant backups.",
                        "old": "A value indicating whether Geo-Redundant backup is enabled on the server."
                      }
                    },
                    {
                      "#name": "earliestRestoreDate",
                      "Description": {
                        "new": "Earliest restore point time (ISO8601 format) for a flexible server.",
                        "old": "The earliest restore point time (ISO8601 format) for server."
                      }
                    }
                  ]
                },
                {
                  "#name": "network",
                  "Description": {
                    "new": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.",
                    "old": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server."
                  },
                  "$properties": [
                    {
                      "#name": "publicNetworkAccess",
                      "Description": {
                        "new": "Indicates if public network access is enabled or not.",
                        "old": "public network access is enabled or not"
                      }
                    },
                    {
                      "#name": "delegatedSubnetResourceId",
                      "Description": {
                        "new": "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.",
                        "old": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                      }
                    },
                    {
                      "#name": "privateDnsZoneArmResourceId",
                      "Description": {
                        "new": "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.",
                        "old": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                      }
                    }
                  ]
                },
                {
                  "#name": "highAvailability",
                  "Description": {
                    "new": "High availability properties of a flexible server.",
                    "old": "High availability properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "mode",
                      "Description": {
                        "new": "High availability mode for a flexible server.",
                        "old": "The HA mode for the server."
                      }
                    },
                    {
                      "#name": "state",
                      "Description": {
                        "new": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.",
                        "old": "A state of a HA server that is visible to user."
                      }
                    },
                    {
                      "#name": "standbyAvailabilityZone",
                      "Description": {
                        "new": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.",
                        "old": "availability zone information of the standby."
                      }
                    }
                  ]
                },
                {
                  "#name": "maintenanceWindow",
                  "Description": {
                    "new": "Maintenance window properties of a flexible server.",
                    "old": "Maintenance window properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "customWindow",
                      "Description": {
                        "new": "Indicates whether custom window is enabled or disabled.",
                        "old": "indicates whether custom window is enabled or disabled"
                      }
                    },
                    {
                      "#name": "startHour",
                      "Description": {
                        "new": "Start hour to be used for maintenance window.",
                        "old": "start hour for maintenance window"
                      }
                    },
                    {
                      "#name": "startMinute",
                      "Description": {
                        "new": "Start minute to be used for maintenance window.",
                        "old": "start minute for maintenance window"
                      }
                    },
                    {
                      "#name": "dayOfWeek",
                      "Description": {
                        "new": "Day of the week to be used for maintenance window.",
                        "old": "day of week for maintenance window"
                      }
                    }
                  ]
                },
                {
                  "#name": "sourceServerResourceId",
                  "Description": {
                    "new": "Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.",
                    "old": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server"
                  }
                },
                {
                  "#name": "pointInTimeUTC",
                  "Description": {
                    "new": "Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.",
                    "old": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'."
                  }
                },
                {
                  "#name": "availabilityZone",
                  "Description": {
                    "new": "Availability zone of a flexible server.",
                    "old": "availability zone information of the server."
                  }
                },
                {
                  "#name": "replicationRole",
                  "Description": {
                    "new": "Role of the server in a replication set.",
                    "old": "Replication role of the server"
                  }
                },
                {
                  "#name": "replicaCapacity",
                  "Description": {
                    "new": "Maximum number of read replicas allowed for a flexible server.",
                    "old": "Replicas allowed for a server."
                  }
                },
                {
                  "#name": "replica",
                  "Description": {
                    "new": "Read replica properties of a flexible server. Required only in case that you want to promote a server.",
                    "old": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server."
                  },
                  "$properties": [
                    {
                      "#name": "role",
                      "Description": {
                        "new": "Role of the server in a replication set.",
                        "old": "Used to indicate role of the server in replication set."
                      }
                    },
                    {
                      "#name": "capacity",
                      "Description": {
                        "new": "Maximum number of read replicas allowed for a flexible server.",
                        "old": "Replicas allowed for a server."
                      }
                    },
                    {
                      "#name": "replicationState",
                      "Description": {
                        "new": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible  values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating",
                        "old": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring"
                      }
                    },
                    {
                      "#name": "promoteMode",
                      "Description": {
                        "new": "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.",
                        "old": "Sets the promote mode for a replica server. This is a write only property."
                      }
                    },
                    {
                      "#name": "promoteOption",
                      "Description": {
                        "new": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.",
                        "old": "Sets the promote options for a replica server. This is a write only property."
                      }
                    }
                  ]
                },
                {
                  "#name": "createMode",
                  "Description": {
                    "new": "Creation mode of a new flexible server.",
                    "old": "The mode to create a new PostgreSQL server."
                  }
                },
                {
                  "#name": "privateEndpointConnections",
                  "Description": {
                    "new": "List of private endpoint connections associated with the specified flexible server.",
                    "old": "List of private endpoint connections associated with the specified resource."
                  }
                },
                {
                  "#name": "cluster",
                  "Description": {
                    "new": "Cluster properties of a flexible server.",
                    "old": "Cluster properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "clusterSize",
                      "Description": {
                        "new": "Number of nodes assigned to the elastic cluster.",
                        "old": "The node count for the cluster."
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of flexible servers ,
Required: False ,
}
[
{
sku:
{
Description: Compute tier and size of a flexible server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a flexible server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a flexible server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the flexible 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 flexible server. ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a flexible server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a flexible 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: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a flexible server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a flexible server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a flexible server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a flexible server. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: 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 flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a flexible server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a flexible server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible 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 flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a flexible server. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a flexible server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a flexible server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a flexible 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 flexible server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a flexible server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone 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 flexible 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 flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a flexible server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a flexible 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 description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: 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: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new flexible server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified flexible 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 flexible server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Servers_List",
  "Description": {
    "new": "Lists all flexible servers in a subscription.",
    "old": "List all the servers in a given subscription."
  },
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "Flexible server.",
            "old": "Represents a server."
          },
          "$properties": [
            {
              "#name": "sku",
              "Description": {
                "new": "Compute tier and size of a flexible server.",
                "old": "The SKU (pricing tier) of the server."
              },
              "$properties": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "Name by which is known a given compute size assigned to a flexible server.",
                    "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Tier of the compute assigned to a flexible server.",
                    "old": "The tier of the particular SKU, e.g. Burstable."
                  }
                }
              ]
            },
            {
              "#name": "identity",
              "Description": {
                "new": "User assigned managed identities assigned to the flexible server.",
                "old": "Describes the identity of the application."
              },
              "$properties": [
                {
                  "#name": "userAssignedIdentities",
                  "Description": {
                    "new": "Map of user assigned managed identities.",
                    "old": "represents user assigned identities map."
                  }
                },
                {
                  "#name": "principalId",
                  "Description": {
                    "new": "Identifier of the object of the service principal associated to the user assigned managed identity.",
                    "old": "the identity principal Id of the server."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Types of identities associated with a flexible server.",
                    "old": "the types of identities associated with this resource"
                  }
                },
                {
                  "#name": "tenantId",
                  "Description": {
                    "new": "Identifier of the tenant of a flexible server.",
                    "old": "Tenant id of the server."
                  }
                }
              ]
            },
            {
              "#name": "properties",
              "Description": {
                "new": "Properties of a flexible server.",
                "old": "Properties of the server."
              },
              "$properties": [
                {
                  "#name": "administratorLogin",
                  "Description": {
                    "new": "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.",
                    "old": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
                  }
                },
                {
                  "#name": "administratorLoginPassword",
                  "Description": {
                    "new": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.",
                    "old": "The administrator login password (required for server creation)."
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Major version of PostgreSQL database engine.",
                    "old": "PostgreSQL Server version."
                  }
                },
                {
                  "#name": "minorVersion",
                  "Description": {
                    "new": "Minor version of PostgreSQL database engine.",
                    "old": "The minor version of the server."
                  }
                },
                {
                  "#name": "state",
                  "Description": {
                    "new": "Possible states of a flexible server.",
                    "old": "A state of a server that is visible to user."
                  }
                },
                {
                  "#name": "fullyQualifiedDomainName",
                  "Description": {
                    "new": "Fully qualified domain name of a flexible server.",
                    "old": "The fully qualified domain name of a server."
                  }
                },
                {
                  "#name": "storage",
                  "Description": {
                    "new": "Storage properties of a flexible server.",
                    "old": "Storage properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "storageSizeGB",
                      "Description": {
                        "new": "Size of storage assigned to a flexible server.",
                        "old": "Max storage allowed for a server."
                      }
                    },
                    {
                      "#name": "autoGrow",
                      "Description": {
                        "new": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.",
                        "old": "Flag to enable / disable Storage Auto grow for flexible server."
                      }
                    },
                    {
                      "#name": "tier",
                      "Description": {
                        "new": "Storage tier of a flexible server.",
                        "old": "Name of storage tier for IOPS."
                      }
                    },
                    {
                      "#name": "iops",
                      "Description": {
                        "new": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                        "old": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                      }
                    },
                    {
                      "#name": "throughput",
                      "Description": {
                        "new": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                        "old": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                      }
                    },
                    {
                      "#name": "type",
                      "Description": {
                        "new": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.",
                        "old": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified"
                      }
                    }
                  ]
                },
                {
                  "#name": "authConfig",
                  "Description": {
                    "new": "Authentication configuration properties of a flexible server.",
                    "old": "AuthConfig properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "activeDirectoryAuth",
                      "Description": {
                        "new": "Indicates if the server supports Microsoft Entra authentication.",
                        "old": "If Enabled, Microsoft Entra authentication is enabled."
                      }
                    },
                    {
                      "#name": "passwordAuth",
                      "Description": {
                        "new": "Indicates if the server supports password based authentication.",
                        "old": "If Enabled, Password authentication is enabled."
                      }
                    },
                    {
                      "#name": "tenantId",
                      "Description": {
                        "new": "Identifier of the tenant of the delegated resource.",
                        "old": "Tenant id of the server."
                      }
                    }
                  ]
                },
                {
                  "#name": "dataEncryption",
                  "Description": {
                    "new": "Data encryption properties of a flexible server.",
                    "old": "Data encryption properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "primaryKeyURI",
                      "Description": {
                        "new": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server.",
                        "old": "URI for the key in keyvault for data encryption of the primary server."
                      }
                    },
                    {
                      "#name": "primaryUserAssignedIdentityId",
                      "Description": {
                        "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server.",
                        "old": "Resource Id for the User assigned identity to be used for data encryption of the primary server."
                      }
                    },
                    {
                      "#name": "geoBackupKeyURI",
                      "Description": {
                        "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                        "old": "URI for the key in keyvault for data encryption for geo-backup of server."
                      }
                    },
                    {
                      "#name": "geoBackupUserAssignedIdentityId",
                      "Description": {
                        "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                        "old": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server."
                      }
                    },
                    {
                      "#name": "type",
                      "Description": {
                        "new": "Data encryption type used by a flexible server.",
                        "old": "Data encryption type to depict if it is System Managed vs Azure Key vault."
                      }
                    },
                    {
                      "#name": "primaryEncryptionKeyStatus",
                      "Description": {
                        "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.",
                        "old": "Primary encryption key status for Data encryption enabled server."
                      }
                    },
                    {
                      "#name": "geoBackupEncryptionKeyStatus",
                      "Description": {
                        "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.",
                        "old": "Geo-backup encryption key status for Data encryption enabled server."
                      }
                    }
                  ]
                },
                {
                  "#name": "backup",
                  "Description": {
                    "new": "Backup properties of a flexible server.",
                    "old": "Backup properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "backupRetentionDays",
                      "Description": {
                        "new": "Backup retention days for the flexible server.",
                        "old": "Backup retention days for the server."
                      }
                    },
                    {
                      "#name": "geoRedundantBackup",
                      "Description": {
                        "new": "Indicates if the server is configured to create geographically redundant backups.",
                        "old": "A value indicating whether Geo-Redundant backup is enabled on the server."
                      }
                    },
                    {
                      "#name": "earliestRestoreDate",
                      "Description": {
                        "new": "Earliest restore point time (ISO8601 format) for a flexible server.",
                        "old": "The earliest restore point time (ISO8601 format) for server."
                      }
                    }
                  ]
                },
                {
                  "#name": "network",
                  "Description": {
                    "new": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.",
                    "old": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server."
                  },
                  "$properties": [
                    {
                      "#name": "publicNetworkAccess",
                      "Description": {
                        "new": "Indicates if public network access is enabled or not.",
                        "old": "public network access is enabled or not"
                      }
                    },
                    {
                      "#name": "delegatedSubnetResourceId",
                      "Description": {
                        "new": "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.",
                        "old": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                      }
                    },
                    {
                      "#name": "privateDnsZoneArmResourceId",
                      "Description": {
                        "new": "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.",
                        "old": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                      }
                    }
                  ]
                },
                {
                  "#name": "highAvailability",
                  "Description": {
                    "new": "High availability properties of a flexible server.",
                    "old": "High availability properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "mode",
                      "Description": {
                        "new": "High availability mode for a flexible server.",
                        "old": "The HA mode for the server."
                      }
                    },
                    {
                      "#name": "state",
                      "Description": {
                        "new": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.",
                        "old": "A state of a HA server that is visible to user."
                      }
                    },
                    {
                      "#name": "standbyAvailabilityZone",
                      "Description": {
                        "new": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.",
                        "old": "availability zone information of the standby."
                      }
                    }
                  ]
                },
                {
                  "#name": "maintenanceWindow",
                  "Description": {
                    "new": "Maintenance window properties of a flexible server.",
                    "old": "Maintenance window properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "customWindow",
                      "Description": {
                        "new": "Indicates whether custom window is enabled or disabled.",
                        "old": "indicates whether custom window is enabled or disabled"
                      }
                    },
                    {
                      "#name": "startHour",
                      "Description": {
                        "new": "Start hour to be used for maintenance window.",
                        "old": "start hour for maintenance window"
                      }
                    },
                    {
                      "#name": "startMinute",
                      "Description": {
                        "new": "Start minute to be used for maintenance window.",
                        "old": "start minute for maintenance window"
                      }
                    },
                    {
                      "#name": "dayOfWeek",
                      "Description": {
                        "new": "Day of the week to be used for maintenance window.",
                        "old": "day of week for maintenance window"
                      }
                    }
                  ]
                },
                {
                  "#name": "sourceServerResourceId",
                  "Description": {
                    "new": "Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.",
                    "old": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server"
                  }
                },
                {
                  "#name": "pointInTimeUTC",
                  "Description": {
                    "new": "Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.",
                    "old": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'."
                  }
                },
                {
                  "#name": "availabilityZone",
                  "Description": {
                    "new": "Availability zone of a flexible server.",
                    "old": "availability zone information of the server."
                  }
                },
                {
                  "#name": "replicationRole",
                  "Description": {
                    "new": "Role of the server in a replication set.",
                    "old": "Replication role of the server"
                  }
                },
                {
                  "#name": "replicaCapacity",
                  "Description": {
                    "new": "Maximum number of read replicas allowed for a flexible server.",
                    "old": "Replicas allowed for a server."
                  }
                },
                {
                  "#name": "replica",
                  "Description": {
                    "new": "Read replica properties of a flexible server. Required only in case that you want to promote a server.",
                    "old": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server."
                  },
                  "$properties": [
                    {
                      "#name": "role",
                      "Description": {
                        "new": "Role of the server in a replication set.",
                        "old": "Used to indicate role of the server in replication set."
                      }
                    },
                    {
                      "#name": "capacity",
                      "Description": {
                        "new": "Maximum number of read replicas allowed for a flexible server.",
                        "old": "Replicas allowed for a server."
                      }
                    },
                    {
                      "#name": "replicationState",
                      "Description": {
                        "new": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible  values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating",
                        "old": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring"
                      }
                    },
                    {
                      "#name": "promoteMode",
                      "Description": {
                        "new": "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.",
                        "old": "Sets the promote mode for a replica server. This is a write only property."
                      }
                    },
                    {
                      "#name": "promoteOption",
                      "Description": {
                        "new": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.",
                        "old": "Sets the promote options for a replica server. This is a write only property."
                      }
                    }
                  ]
                },
                {
                  "#name": "createMode",
                  "Description": {
                    "new": "Creation mode of a new flexible server.",
                    "old": "The mode to create a new PostgreSQL server."
                  }
                },
                {
                  "#name": "privateEndpointConnections",
                  "Description": {
                    "new": "List of private endpoint connections associated with the specified flexible server.",
                    "old": "List of private endpoint connections associated with the specified resource."
                  }
                },
                {
                  "#name": "cluster",
                  "Description": {
                    "new": "Cluster properties of a flexible server.",
                    "old": "Cluster properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "clusterSize",
                      "Description": {
                        "new": "Number of nodes assigned to the elastic cluster.",
                        "old": "The node count for the cluster."
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of flexible servers ,
Required: False ,
}
[
{
sku:
{
Description: Compute tier and size of a flexible server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a flexible server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a flexible server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the flexible 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 flexible server. ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a flexible server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a flexible 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: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a flexible server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a flexible server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a flexible server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a flexible server. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: 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 flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a flexible server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a flexible server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible 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 flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a flexible server. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a flexible server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a flexible server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a flexible 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 flexible server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a flexible server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone 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 flexible 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 flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a flexible server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a flexible 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 description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: 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: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new flexible server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified flexible 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 flexible server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FlexibleServer_TriggerLtrPreBackup (updated)
Description :  Performs all checks required so that a subsequent long term retention backup operation succeeds.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FlexibleServer_TriggerLtrPreBackup",
  "Description": {
    "new": "Performs all checks required so that a subsequent long term retention backup operation succeeds.",
    "old": "PreBackup operation performs all the checks that are needed for the subsequent long term retention backup operation to succeed."
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: ErrorCode string in the event of a failure. ,
}
string ,
x-ms-request-id:
{
Description: A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
Migrations_Create (updated)
Description :  Creates a new migration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migrations_Create",
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "Identifier of subscription of target database server.",
        "old": "The subscription ID of the target database server."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "Name of resource group of target database server.",
        "old": "The resource group name of the target database server."
      }
    },
    {
      "#name": "targetDbServerName",
      "Description": {
        "new": "Name of target database server.",
        "old": "The name of the target database server."
      }
    },
    {
      "#name": "migrationName",
      "Description": {
        "new": "Name of migration.",
        "old": "The name of the migration."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required for creating a migration.",
        "old": "The required parameters for creating a migration."
      },
      "$schema": {
        "Description": {
          "new": "Migration.",
          "old": "Represents a migration resource."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Migration properties.",
              "old": "Migration resource properties."
            },
            "$properties": [
              {
                "#name": "migrationId",
                "Description": {
                  "new": "Identifier of a migration.",
                  "old": "ID for migration, a GUID."
                }
              },
              {
                "#name": "currentStatus",
                "Description": {
                  "new": "Current status of a migration.",
                  "old": "Current status of migration"
                },
                "$properties": [
                  {
                    "#name": "state",
                    "Description": {
                      "new": "State of migration.",
                      "old": "State of migration"
                    }
                  },
                  {
                    "#name": "error",
                    "Description": {
                      "new": "Error message, if any, for the migration state.",
                      "old": "Error message, if any, for the migration state"
                    }
                  },
                  {
                    "#name": "currentSubStateDetails",
                    "Description": {
                      "new": "Current migration sub state details.",
                      "old": "Current Migration sub state details."
                    },
                    "$properties": [
                      {
                        "#name": "currentSubState",
                        "Description": {
                          "new": "Substate of migration.",
                          "old": "Migration sub state."
                        }
                      },
                      {
                        "#name": "validationDetails",
                        "Description": {
                          "new": "Details for the validation for migration.",
                          "old": "Details for the validation for migration"
                        },
                        "$properties": [
                          {
                            "#name": "status",
                            "Description": {
                              "new": "Validation status for migration.",
                              "old": "Validation status for migration"
                            }
                          },
                          {
                            "#name": "validationStartTimeInUtc",
                            "Description": {
                              "new": "Start time (UTC) for validation.",
                              "old": "Validation Start date-time in UTC"
                            }
                          },
                          {
                            "#name": "validationEndTimeInUtc",
                            "Description": {
                              "new": "End time (UTC) for validation.",
                              "old": "Validation End date-time in UTC"
                            }
                          },
                          {
                            "#name": "serverLevelValidationDetails",
                            "Description": {
                              "new": "Details of server level validations.",
                              "old": "Details of server level validations"
                            },
                            "$items": {
                              "Description": {
                                "new": "Validation summary object.",
                                "old": "Validation summary object"
                              },
                              "$properties": [
                                {
                                  "#name": "type",
                                  "Description": {
                                    "new": "Validation type.",
                                    "old": "Validation type"
                                  }
                                },
                                {
                                  "#name": "state",
                                  "Description": {
                                    "new": "Validation status for migration.",
                                    "old": "Validation status for migration"
                                  }
                                },
                                {
                                  "#name": "messages",
                                  "Description": {
                                    "new": "Validation messages.",
                                    "old": "Validation messages"
                                  },
                                  "$items": {
                                    "Description": {
                                      "new": "Validation message object.",
                                      "old": "Validation message object"
                                    },
                                    "$properties": [
                                      {
                                        "#name": "state",
                                        "Description": {
                                          "new": "Severity of validation message.",
                                          "old": "Severity of validation message"
                                        }
                                      },
                                      {
                                        "#name": "message",
                                        "Description": {
                                          "new": "Validation message string.",
                                          "old": "Validation message string"
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          },
                          {
                            "#name": "dbLevelValidationDetails",
                            "Description": {
                              "new": "Details of server level validations.",
                              "old": "Details of server level validations"
                            },
                            "$items": {
                              "Description": {
                                "new": "Validation status summary for a database.",
                                "old": "Validation status summary for an individual database"
                              },
                              "$properties": [
                                {
                                  "#name": "databaseName",
                                  "Description": {
                                    "new": "Name of database.",
                                    "old": "Name of the database"
                                  }
                                },
                                {
                                  "#name": "startedOn",
                                  "Description": {
                                    "new": "Start time of a database level validation.",
                                    "old": "Start date-time of a database level validation"
                                  }
                                },
                                {
                                  "#name": "endedOn",
                                  "Description": {
                                    "new": "End time of a database level validation.",
                                    "old": "End date-time of a database level validation"
                                  }
                                },
                                {
                                  "#name": "summary",
                                  "Description": {
                                    "new": "Summary of database level validations.",
                                    "old": "Summary of database level validations"
                                  },
                                  "$items": {
                                    "Description": {
                                      "new": "Validation summary object.",
                                      "old": "Validation summary object"
                                    },
                                    "$properties": [
                                      {
                                        "#name": "type",
                                        "Description": {
                                          "new": "Validation type.",
                                          "old": "Validation type"
                                        }
                                      },
                                      {
                                        "#name": "state",
                                        "Description": {
                                          "new": "Validation status for migration.",
                                          "old": "Validation status for migration"
                                        }
                                      },
                                      {
                                        "#name": "messages",
                                        "Description": {
                                          "new": "Validation messages.",
                                          "old": "Validation messages"
                                        },
                                        "$items": {
                                          "Description": {
                                            "new": "Validation message object.",
                                            "old": "Validation message object"
                                          },
                                          "$properties": [
                                            {
                                              "#name": "state",
                                              "Description": {
                                                "new": "Severity of validation message.",
                                                "old": "Severity of validation message"
                                              }
                                            },
                                            {
                                              "#name": "message",
                                              "Description": {
                                                "new": "Validation message string.",
                                                "old": "Validation message string"
                                              }
                                            }
                                          ]
                                        }
                                      }
                                    ]
                                  }
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "migrationInstanceResourceId",
                "Description": {
                  "new": "Identifier of the private endpoint migration instance.",
                  "old": "ResourceId of the private endpoint migration instance"
                }
              },
              {
                "#name": "migrationMode",
                "Description": {
                  "new": "Mode used to perform the migration: Online or Offline.",
                  "old": "There are two types of migration modes Online and Offline"
                }
              },
              {
                "#name": "migrationOption",
                "Description": {
                  "new": "Supported option for a migration.",
                  "old": "This indicates the supported Migration option for the migration"
                }
              },
              {
                "#name": "sourceType",
                "Description": {
                  "new": "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",
                  "old": "migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL"
                }
              },
              {
                "#name": "sslMode",
                "Description": {
                  "new": "SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.",
                  "old": "SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types"
                }
              },
              {
                "#name": "sourceDbServerMetadata",
                "Description": {
                  "new": "Metadata of source database server.",
                  "old": "Metadata of the source database server"
                },
                "$properties": [
                  {
                    "#name": "location",
                    "Description": {
                      "new": "Location of database server.",
                      "old": "Location of database server"
                    }
                  },
                  {
                    "#name": "version",
                    "Description": {
                      "new": "Major version of PostgreSQL database engine.",
                      "old": "Version for database engine"
                    }
                  },
                  {
                    "#name": "storageMb",
                    "Description": {
                      "new": "Storage size (in MB) for database server.",
                      "old": "Storage size in MB for database server"
                    }
                  },
                  {
                    "#name": "sku",
                    "Description": {
                      "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                      "old": "SKU for the database server. This object is empty for PG single server"
                    },
                    "$properties": [
                      {
                        "#name": "name",
                        "Description": {
                          "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                          "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                        }
                      },
                      {
                        "#name": "tier",
                        "Description": {
                          "new": "Tier of the compute assigned to a flexible server.",
                          "old": "The tier of the particular SKU, e.g. Burstable."
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "targetDbServerMetadata",
                "Description": {
                  "new": "Metadata of target database server.",
                  "old": "Metadata of the target database server"
                },
                "$properties": [
                  {
                    "#name": "location",
                    "Description": {
                      "new": "Location of database server.",
                      "old": "Location of database server"
                    }
                  },
                  {
                    "#name": "version",
                    "Description": {
                      "new": "Major version of PostgreSQL database engine.",
                      "old": "Version for database engine"
                    }
                  },
                  {
                    "#name": "storageMb",
                    "Description": {
                      "new": "Storage size (in MB) for database server.",
                      "old": "Storage size in MB for database server"
                    }
                  },
                  {
                    "#name": "sku",
                    "Description": {
                      "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                      "old": "SKU for the database server. This object is empty for PG single server"
                    },
                    "$properties": [
                      {
                        "#name": "name",
                        "Description": {
                          "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                          "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                        }
                      },
                      {
                        "#name": "tier",
                        "Description": {
                          "new": "Tier of the compute assigned to a flexible server.",
                          "old": "The tier of the particular SKU, e.g. Burstable."
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "sourceDbServerResourceId",
                "Description": {
                  "new": "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.",
                  "old": "ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username"
                }
              },
              {
                "#name": "sourceDbServerFullyQualifiedDomainName",
                "Description": {
                  "new": "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.",
                  "old": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection"
                }
              },
              {
                "#name": "targetDbServerResourceId",
                "Description": {
                  "new": "Identifier of the target database server resource.",
                  "old": "ResourceId of the source database server"
                }
              },
              {
                "#name": "targetDbServerFullyQualifiedDomainName",
                "Description": {
                  "new": "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.",
                  "old": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection"
                }
              },
              {
                "#name": "secretParameters",
                "Description": {
                  "new": "Migration secret parameters.",
                  "old": "Migration secret parameters"
                },
                "$properties": [
                  {
                    "#name": "adminCredentials",
                    "Description": {
                      "new": "Credentials of administrator users for source and target servers.",
                      "old": "Admin credentials for source and target servers"
                    },
                    "$properties": [
                      {
                        "#name": "sourceServerPassword",
                        "Description": {
                          "new": "Password for the user of the source server.",
                          "old": "Password for source server."
                        }
                      },
                      {
                        "#name": "targetServerPassword",
                        "Description": {
                          "new": "Password for the user of the target server.",
                          "old": "Password for target server."
                        }
                      }
                    ]
                  },
                  {
                    "#name": "sourceServerUsername",
                    "Description": {
                      "new": "Gets or sets the name of the user for the source server. This user doesn't need to be an administrator.",
                      "old": "Gets or sets the username for the source server. This user need not be an admin."
                    }
                  },
                  {
                    "#name": "targetServerUsername",
                    "Description": {
                      "new": "Gets or sets the name of the user for the target server. This user doesn't need to be an administrator.",
                      "old": "Gets or sets the username for the target server. This user need not be an admin."
                    }
                  }
                ]
              },
              {
                "#name": "dbsToMigrate",
                "Description": {
                  "new": "Names of databases to migrate.",
                  "old": "Number of databases to migrate"
                }
              },
              {
                "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
                "Description": {
                  "new": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed.",
                  "old": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed"
                }
              },
              {
                "#name": "overwriteDbsInTarget",
                "Description": {
                  "new": "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.",
                  "old": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists."
                }
              },
              {
                "#name": "migrationWindowStartTimeInUtc",
                "Description": {
                  "new": "Start time (UTC) for migration window.",
                  "old": "Start time in UTC for migration window"
                }
              },
              {
                "#name": "migrationWindowEndTimeInUtc",
                "Description": {
                  "new": "End time (UTC) for migration window.",
                  "old": "End time in UTC for migration window"
                }
              },
              {
                "#name": "migrateRoles",
                "Description": {
                  "new": "Indicates if roles and permissions must be migrated.",
                  "old": "To migrate roles and permissions we need to send this flag as True"
                }
              },
              {
                "#name": "startDataMigration",
                "Description": {
                  "new": "Indicates if data migration must start right away.",
                  "old": "Indicates whether the data migration should start right away"
                }
              },
              {
                "#name": "triggerCutover",
                "Description": {
                  "new": "Indicates if cutover must be triggered for the entire migration.",
                  "old": "To trigger cutover for entire migration we need to send this flag as True"
                }
              },
              {
                "#name": "dbsToTriggerCutoverOn",
                "Description": {
                  "new": "When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.",
                  "old": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array"
                }
              },
              {
                "#name": "cancel",
                "Description": {
                  "new": "Indicates if cancel must be triggered for the entire migration.",
                  "old": "To trigger cancel for entire migration we need to send this flag as True"
                }
              },
              {
                "#name": "dbsToCancelMigrationOn",
                "Description": {
                  "new": "When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.",
                  "old": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array"
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Migration.",
        "old": "Represents a migration resource."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Migration properties.",
            "old": "Migration resource properties."
          },
          "$properties": [
            {
              "#name": "migrationId",
              "Description": {
                "new": "Identifier of a migration.",
                "old": "ID for migration, a GUID."
              }
            },
            {
              "#name": "currentStatus",
              "Description": {
                "new": "Current status of a migration.",
                "old": "Current status of migration"
              },
              "$properties": [
                {
                  "#name": "state",
                  "Description": {
                    "new": "State of migration.",
                    "old": "State of migration"
                  }
                },
                {
                  "#name": "error",
                  "Description": {
                    "new": "Error message, if any, for the migration state.",
                    "old": "Error message, if any, for the migration state"
                  }
                },
                {
                  "#name": "currentSubStateDetails",
                  "Description": {
                    "new": "Current migration sub state details.",
                    "old": "Current Migration sub state details."
                  },
                  "$properties": [
                    {
                      "#name": "currentSubState",
                      "Description": {
                        "new": "Substate of migration.",
                        "old": "Migration sub state."
                      }
                    },
                    {
                      "#name": "validationDetails",
                      "Description": {
                        "new": "Details for the validation for migration.",
                        "old": "Details for the validation for migration"
                      },
                      "$properties": [
                        {
                          "#name": "status",
                          "Description": {
                            "new": "Validation status for migration.",
                            "old": "Validation status for migration"
                          }
                        },
                        {
                          "#name": "validationStartTimeInUtc",
                          "Description": {
                            "new": "Start time (UTC) for validation.",
                            "old": "Validation Start date-time in UTC"
                          }
                        },
                        {
                          "#name": "validationEndTimeInUtc",
                          "Description": {
                            "new": "End time (UTC) for validation.",
                            "old": "Validation End date-time in UTC"
                          }
                        },
                        {
                          "#name": "serverLevelValidationDetails",
                          "Description": {
                            "new": "Details of server level validations.",
                            "old": "Details of server level validations"
                          },
                          "$items": {
                            "Description": {
                              "new": "Validation summary object.",
                              "old": "Validation summary object"
                            },
                            "$properties": [
                              {
                                "#name": "type",
                                "Description": {
                                  "new": "Validation type.",
                                  "old": "Validation type"
                                }
                              },
                              {
                                "#name": "state",
                                "Description": {
                                  "new": "Validation status for migration.",
                                  "old": "Validation status for migration"
                                }
                              },
                              {
                                "#name": "messages",
                                "Description": {
                                  "new": "Validation messages.",
                                  "old": "Validation messages"
                                },
                                "$items": {
                                  "Description": {
                                    "new": "Validation message object.",
                                    "old": "Validation message object"
                                  },
                                  "$properties": [
                                    {
                                      "#name": "state",
                                      "Description": {
                                        "new": "Severity of validation message.",
                                        "old": "Severity of validation message"
                                      }
                                    },
                                    {
                                      "#name": "message",
                                      "Description": {
                                        "new": "Validation message string.",
                                        "old": "Validation message string"
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "#name": "dbLevelValidationDetails",
                          "Description": {
                            "new": "Details of server level validations.",
                            "old": "Details of server level validations"
                          },
                          "$items": {
                            "Description": {
                              "new": "Validation status summary for a database.",
                              "old": "Validation status summary for an individual database"
                            },
                            "$properties": [
                              {
                                "#name": "databaseName",
                                "Description": {
                                  "new": "Name of database.",
                                  "old": "Name of the database"
                                }
                              },
                              {
                                "#name": "startedOn",
                                "Description": {
                                  "new": "Start time of a database level validation.",
                                  "old": "Start date-time of a database level validation"
                                }
                              },
                              {
                                "#name": "endedOn",
                                "Description": {
                                  "new": "End time of a database level validation.",
                                  "old": "End date-time of a database level validation"
                                }
                              },
                              {
                                "#name": "summary",
                                "Description": {
                                  "new": "Summary of database level validations.",
                                  "old": "Summary of database level validations"
                                },
                                "$items": {
                                  "Description": {
                                    "new": "Validation summary object.",
                                    "old": "Validation summary object"
                                  },
                                  "$properties": [
                                    {
                                      "#name": "type",
                                      "Description": {
                                        "new": "Validation type.",
                                        "old": "Validation type"
                                      }
                                    },
                                    {
                                      "#name": "state",
                                      "Description": {
                                        "new": "Validation status for migration.",
                                        "old": "Validation status for migration"
                                      }
                                    },
                                    {
                                      "#name": "messages",
                                      "Description": {
                                        "new": "Validation messages.",
                                        "old": "Validation messages"
                                      },
                                      "$items": {
                                        "Description": {
                                          "new": "Validation message object.",
                                          "old": "Validation message object"
                                        },
                                        "$properties": [
                                          {
                                            "#name": "state",
                                            "Description": {
                                              "new": "Severity of validation message.",
                                              "old": "Severity of validation message"
                                            }
                                          },
                                          {
                                            "#name": "message",
                                            "Description": {
                                              "new": "Validation message string.",
                                              "old": "Validation message string"
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            },
            {
              "#name": "migrationInstanceResourceId",
              "Description": {
                "new": "Identifier of the private endpoint migration instance.",
                "old": "ResourceId of the private endpoint migration instance"
              }
            },
            {
              "#name": "migrationMode",
              "Description": {
                "new": "Mode used to perform the migration: Online or Offline.",
                "old": "There are two types of migration modes Online and Offline"
              }
            },
            {
              "#name": "migrationOption",
              "Description": {
                "new": "Supported option for a migration.",
                "old": "This indicates the supported Migration option for the migration"
              }
            },
            {
              "#name": "sourceType",
              "Description": {
                "new": "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",
                "old": "migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL"
              }
            },
            {
              "#name": "sslMode",
              "Description": {
                "new": "SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.",
                "old": "SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types"
              }
            },
            {
              "#name": "sourceDbServerMetadata",
              "Description": {
                "new": "Metadata of source database server.",
                "old": "Metadata of the source database server"
              },
              "$properties": [
                {
                  "#name": "location",
                  "Description": {
                    "new": "Location of database server.",
                    "old": "Location of database server"
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Major version of PostgreSQL database engine.",
                    "old": "Version for database engine"
                  }
                },
                {
                  "#name": "storageMb",
                  "Description": {
                    "new": "Storage size (in MB) for database server.",
                    "old": "Storage size in MB for database server"
                  }
                },
                {
                  "#name": "sku",
                  "Description": {
                    "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                    "old": "SKU for the database server. This object is empty for PG single server"
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                        "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                      }
                    },
                    {
                      "#name": "tier",
                      "Description": {
                        "new": "Tier of the compute assigned to a flexible server.",
                        "old": "The tier of the particular SKU, e.g. Burstable."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "targetDbServerMetadata",
              "Description": {
                "new": "Metadata of target database server.",
                "old": "Metadata of the target database server"
              },
              "$properties": [
                {
                  "#name": "location",
                  "Description": {
                    "new": "Location of database server.",
                    "old": "Location of database server"
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Major version of PostgreSQL database engine.",
                    "old": "Version for database engine"
                  }
                },
                {
                  "#name": "storageMb",
                  "Description": {
                    "new": "Storage size (in MB) for database server.",
                    "old": "Storage size in MB for database server"
                  }
                },
                {
                  "#name": "sku",
                  "Description": {
                    "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                    "old": "SKU for the database server. This object is empty for PG single server"
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                        "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                      }
                    },
                    {
                      "#name": "tier",
                      "Description": {
                        "new": "Tier of the compute assigned to a flexible server.",
                        "old": "The tier of the particular SKU, e.g. Burstable."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "sourceDbServerResourceId",
              "Description": {
                "new": "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.",
                "old": "ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username"
              }
            },
            {
              "#name": "sourceDbServerFullyQualifiedDomainName",
              "Description": {
                "new": "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.",
                "old": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection"
              }
            },
            {
              "#name": "targetDbServerResourceId",
              "Description": {
                "new": "Identifier of the target database server resource.",
                "old": "ResourceId of the source database server"
              }
            },
            {
              "#name": "targetDbServerFullyQualifiedDomainName",
              "Description": {
                "new": "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.",
                "old": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection"
              }
            },
            {
              "#name": "secretParameters",
              "Description": {
                "new": "Migration secret parameters.",
                "old": "Migration secret parameters"
              },
              "$properties": [
                {
                  "#name": "adminCredentials",
                  "Description": {
                    "new": "Credentials of administrator users for source and target servers.",
                    "old": "Admin credentials for source and target servers"
                  },
                  "$properties": [
                    {
                      "#name": "sourceServerPassword",
                      "Description": {
                        "new": "Password for the user of the source server.",
                        "old": "Password for source server."
                      }
                    },
                    {
                      "#name": "targetServerPassword",
                      "Description": {
                        "new": "Password for the user of the target server.",
                        "old": "Password for target server."
                      }
                    }
                  ]
                },
                {
                  "#name": "sourceServerUsername",
                  "Description": {
                    "new": "Gets or sets the name of the user for the source server. This user doesn't need to be an administrator.",
                    "old": "Gets or sets the username for the source server. This user need not be an admin."
                  }
                },
                {
                  "#name": "targetServerUsername",
                  "Description": {
                    "new": "Gets or sets the name of the user for the target server. This user doesn't need to be an administrator.",
                    "old": "Gets or sets the username for the target server. This user need not be an admin."
                  }
                }
              ]
            },
            {
              "#name": "dbsToMigrate",
              "Description": {
                "new": "Names of databases to migrate.",
                "old": "Number of databases to migrate"
              }
            },
            {
              "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
              "Description": {
                "new": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed.",
                "old": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed"
              }
            },
            {
              "#name": "overwriteDbsInTarget",
              "Description": {
                "new": "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.",
                "old": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists."
              }
            },
            {
              "#name": "migrationWindowStartTimeInUtc",
              "Description": {
                "new": "Start time (UTC) for migration window.",
                "old": "Start time in UTC for migration window"
              }
            },
            {
              "#name": "migrationWindowEndTimeInUtc",
              "Description": {
                "new": "End time (UTC) for migration window.",
                "old": "End time in UTC for migration window"
              }
            },
            {
              "#name": "migrateRoles",
              "Description": {
                "new": "Indicates if roles and permissions must be migrated.",
                "old": "To migrate roles and permissions we need to send this flag as True"
              }
            },
            {
              "#name": "startDataMigration",
              "Description": {
                "new": "Indicates if data migration must start right away.",
                "old": "Indicates whether the data migration should start right away"
              }
            },
            {
              "#name": "triggerCutover",
              "Description": {
                "new": "Indicates if cutover must be triggered for the entire migration.",
                "old": "To trigger cutover for entire migration we need to send this flag as True"
              }
            },
            {
              "#name": "dbsToTriggerCutoverOn",
              "Description": {
                "new": "When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.",
                "old": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array"
              }
            },
            {
              "#name": "cancel",
              "Description": {
                "new": "Indicates if cancel must be triggered for the entire migration.",
                "old": "To trigger cancel for entire migration we need to send this flag as True"
              }
            },
            {
              "#name": "dbsToCancelMigrationOn",
              "Description": {
                "new": "When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.",
                "old": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array"
              }
            }
          ]
        }
      ]
    },
    "201": {
      "Description": {
        "new": "Migration.",
        "old": "Represents a migration resource."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Migration properties.",
            "old": "Migration resource properties."
          },
          "$properties": [
            {
              "#name": "migrationId",
              "Description": {
                "new": "Identifier of a migration.",
                "old": "ID for migration, a GUID."
              }
            },
            {
              "#name": "currentStatus",
              "Description": {
                "new": "Current status of a migration.",
                "old": "Current status of migration"
              },
              "$properties": [
                {
                  "#name": "state",
                  "Description": {
                    "new": "State of migration.",
                    "old": "State of migration"
                  }
                },
                {
                  "#name": "error",
                  "Description": {
                    "new": "Error message, if any, for the migration state.",
                    "old": "Error message, if any, for the migration state"
                  }
                },
                {
                  "#name": "currentSubStateDetails",
                  "Description": {
                    "new": "Current migration sub state details.",
                    "old": "Current Migration sub state details."
                  },
                  "$properties": [
                    {
                      "#name": "currentSubState",
                      "Description": {
                        "new": "Substate of migration.",
                        "old": "Migration sub state."
                      }
                    },
                    {
                      "#name": "validationDetails",
                      "Description": {
                        "new": "Details for the validation for migration.",
                        "old": "Details for the validation for migration"
                      },
                      "$properties": [
                        {
                          "#name": "status",
                          "Description": {
                            "new": "Validation status for migration.",
                            "old": "Validation status for migration"
                          }
                        },
                        {
                          "#name": "validationStartTimeInUtc",
                          "Description": {
                            "new": "Start time (UTC) for validation.",
                            "old": "Validation Start date-time in UTC"
                          }
                        },
                        {
                          "#name": "validationEndTimeInUtc",
                          "Description": {
                            "new": "End time (UTC) for validation.",
                            "old": "Validation End date-time in UTC"
                          }
                        },
                        {
                          "#name": "serverLevelValidationDetails",
                          "Description": {
                            "new": "Details of server level validations.",
                            "old": "Details of server level validations"
                          },
                          "$items": {
                            "Description": {
                              "new": "Validation summary object.",
                              "old": "Validation summary object"
                            },
                            "$properties": [
                              {
                                "#name": "type",
                                "Description": {
                                  "new": "Validation type.",
                                  "old": "Validation type"
                                }
                              },
                              {
                                "#name": "state",
                                "Description": {
                                  "new": "Validation status for migration.",
                                  "old": "Validation status for migration"
                                }
                              },
                              {
                                "#name": "messages",
                                "Description": {
                                  "new": "Validation messages.",
                                  "old": "Validation messages"
                                },
                                "$items": {
                                  "Description": {
                                    "new": "Validation message object.",
                                    "old": "Validation message object"
                                  },
                                  "$properties": [
                                    {
                                      "#name": "state",
                                      "Description": {
                                        "new": "Severity of validation message.",
                                        "old": "Severity of validation message"
                                      }
                                    },
                                    {
                                      "#name": "message",
                                      "Description": {
                                        "new": "Validation message string.",
                                        "old": "Validation message string"
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        },
                        {
                          "#name": "dbLevelValidationDetails",
                          "Description": {
                            "new": "Details of server level validations.",
                            "old": "Details of server level validations"
                          },
                          "$items": {
                            "Description": {
                              "new": "Validation status summary for a database.",
                              "old": "Validation status summary for an individual database"
                            },
                            "$properties": [
                              {
                                "#name": "databaseName",
                                "Description": {
                                  "new": "Name of database.",
                                  "old": "Name of the database"
                                }
                              },
                              {
                                "#name": "startedOn",
                                "Description": {
                                  "new": "Start time of a database level validation.",
                                  "old": "Start date-time of a database level validation"
                                }
                              },
                              {
                                "#name": "endedOn",
                                "Description": {
                                  "new": "End time of a database level validation.",
                                  "old": "End date-time of a database level validation"
                                }
                              },
                              {
                                "#name": "summary",
                                "Description": {
                                  "new": "Summary of database level validations.",
                                  "old": "Summary of database level validations"
                                },
                                "$items": {
                                  "Description": {
                                    "new": "Validation summary object.",
                                    "old": "Validation summary object"
                                  },
                                  "$properties": [
                                    {
                                      "#name": "type",
                                      "Description": {
                                        "new": "Validation type.",
                                        "old": "Validation type"
                                      }
                                    },
                                    {
                                      "#name": "state",
                                      "Description": {
                                        "new": "Validation status for migration.",
                                        "old": "Validation status for migration"
                                      }
                                    },
                                    {
                                      "#name": "messages",
                                      "Description": {
                                        "new": "Validation messages.",
                                        "old": "Validation messages"
                                      },
                                      "$items": {
                                        "Description": {
                                          "new": "Validation message object.",
                                          "old": "Validation message object"
                                        },
                                        "$properties": [
                                          {
                                            "#name": "state",
                                            "Description": {
                                              "new": "Severity of validation message.",
                                              "old": "Severity of validation message"
                                            }
                                          },
                                          {
                                            "#name": "message",
                                            "Description": {
                                              "new": "Validation message string.",
                                              "old": "Validation message string"
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            },
            {
              "#name": "migrationInstanceResourceId",
              "Description": {
                "new": "Identifier of the private endpoint migration instance.",
                "old": "ResourceId of the private endpoint migration instance"
              }
            },
            {
              "#name": "migrationMode",
              "Description": {
                "new": "Mode used to perform the migration: Online or Offline.",
                "old": "There are two types of migration modes Online and Offline"
              }
            },
            {
              "#name": "migrationOption",
              "Description": {
                "new": "Supported option for a migration.",
                "old": "This indicates the supported Migration option for the migration"
              }
            },
            {
              "#name": "sourceType",
              "Description": {
                "new": "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",
                "old": "migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL"
              }
            },
            {
              "#name": "sslMode",
              "Description": {
                "new": "SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.",
                "old": "SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types"
              }
            },
            {
              "#name": "sourceDbServerMetadata",
              "Description": {
                "new": "Metadata of source database server.",
                "old": "Metadata of the source database server"
              },
              "$properties": [
                {
                  "#name": "location",
                  "Description": {
                    "new": "Location of database server.",
                    "old": "Location of database server"
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Major version of PostgreSQL database engine.",
                    "old": "Version for database engine"
                  }
                },
                {
                  "#name": "storageMb",
                  "Description": {
                    "new": "Storage size (in MB) for database server.",
                    "old": "Storage size in MB for database server"
                  }
                },
                {
                  "#name": "sku",
                  "Description": {
                    "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                    "old": "SKU for the database server. This object is empty for PG single server"
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                        "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                      }
                    },
                    {
                      "#name": "tier",
                      "Description": {
                        "new": "Tier of the compute assigned to a flexible server.",
                        "old": "The tier of the particular SKU, e.g. Burstable."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "targetDbServerMetadata",
              "Description": {
                "new": "Metadata of target database server.",
                "old": "Metadata of the target database server"
              },
              "$properties": [
                {
                  "#name": "location",
                  "Description": {
                    "new": "Location of database server.",
                    "old": "Location of database server"
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Major version of PostgreSQL database engine.",
                    "old": "Version for database engine"
                  }
                },
                {
                  "#name": "storageMb",
                  "Description": {
                    "new": "Storage size (in MB) for database server.",
                    "old": "Storage size in MB for database server"
                  }
                },
                {
                  "#name": "sku",
                  "Description": {
                    "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                    "old": "SKU for the database server. This object is empty for PG single server"
                  },
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                        "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                      }
                    },
                    {
                      "#name": "tier",
                      "Description": {
                        "new": "Tier of the compute assigned to a flexible server.",
                        "old": "The tier of the particular SKU, e.g. Burstable."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "sourceDbServerResourceId",
              "Description": {
                "new": "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.",
                "old": "ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username"
              }
            },
            {
              "#name": "sourceDbServerFullyQualifiedDomainName",
              "Description": {
                "new": "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.",
                "old": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection"
              }
            },
            {
              "#name": "targetDbServerResourceId",
              "Description": {
                "new": "Identifier of the target database server resource.",
                "old": "ResourceId of the source database server"
              }
            },
            {
              "#name": "targetDbServerFullyQualifiedDomainName",
              "Description": {
                "new": "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.",
                "old": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection"
              }
            },
            {
              "#name": "secretParameters",
              "Description": {
                "new": "Migration secret parameters.",
                "old": "Migration secret parameters"
              },
              "$properties": [
                {
                  "#name": "adminCredentials",
                  "Description": {
                    "new": "Credentials of administrator users for source and target servers.",
                    "old": "Admin credentials for source and target servers"
                  },
                  "$properties": [
                    {
                      "#name": "sourceServerPassword",
                      "Description": {
                        "new": "Password for the user of the source server.",
                        "old": "Password for source server."
                      }
                    },
                    {
                      "#name": "targetServerPassword",
                      "Description": {
                        "new": "Password for the user of the target server.",
                        "old": "Password for target server."
                      }
                    }
                  ]
                },
                {
                  "#name": "sourceServerUsername",
                  "Description": {
                    "new": "Gets or sets the name of the user for the source server. This user doesn't need to be an administrator.",
                    "old": "Gets or sets the username for the source server. This user need not be an admin."
                  }
                },
                {
                  "#name": "targetServerUsername",
                  "Description": {
                    "new": "Gets or sets the name of the user for the target server. This user doesn't need to be an administrator.",
                    "old": "Gets or sets the username for the target server. This user need not be an admin."
                  }
                }
              ]
            },
            {
              "#name": "dbsToMigrate",
              "Description": {
                "new": "Names of databases to migrate.",
                "old": "Number of databases to migrate"
              }
            },
            {
              "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
              "Description": {
                "new": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed.",
                "old": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed"
              }
            },
            {
              "#name": "overwriteDbsInTarget",
              "Description": {
                "new": "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.",
                "old": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists."
              }
            },
            {
              "#name": "migrationWindowStartTimeInUtc",
              "Description": {
                "new": "Start time (UTC) for migration window.",
                "old": "Start time in UTC for migration window"
              }
            },
            {
              "#name": "migrationWindowEndTimeInUtc",
              "Description": {
                "new": "End time (UTC) for migration window.",
                "old": "End time in UTC for migration window"
              }
            },
            {
              "#name": "migrateRoles",
              "Description": {
                "new": "Indicates if roles and permissions must be migrated.",
                "old": "To migrate roles and permissions we need to send this flag as True"
              }
            },
            {
              "#name": "startDataMigration",
              "Description": {
                "new": "Indicates if data migration must start right away.",
                "old": "Indicates whether the data migration should start right away"
              }
            },
            {
              "#name": "triggerCutover",
              "Description": {
                "new": "Indicates if cutover must be triggered for the entire migration.",
                "old": "To trigger cutover for entire migration we need to send this flag as True"
              }
            },
            {
              "#name": "dbsToTriggerCutoverOn",
              "Description": {
                "new": "When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.",
                "old": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array"
              }
            },
            {
              "#name": "cancel",
              "Description": {
                "new": "Indicates if cancel must be triggered for the entire migration.",
                "old": "To trigger cancel for entire migration we need to send this flag as True"
              }
            },
            {
              "#name": "dbsToCancelMigrationOn",
              "Description": {
                "new": "When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.",
                "old": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array"
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

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

⚼ Request

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Identifier of subscription of target database server. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of resource group of target database server. ,
Required: True ,
}
string ,
targetDbServerName:
{
Description: Name of target database 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: 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 LogicalReplicationOnSourceDb, if needed. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Migration 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: No description available. ,
WaitingForUserAction: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ValidationFailed: No description available. ,
CleaningUp: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error message, if any, for the migration state. ,
Required: False ,
}
string ,
currentSubStateDetails:
{
Description: Current migration sub state details. ,
Required: False ,
}
{
currentSubState:
{
Description: Substate of migration. ,
Enum:
{
PerformingPreRequisiteSteps: No description available. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: No description available. ,
WaitingForDBsToMigrateSpecification: No description available. ,
WaitingForTargetDBOverwriteConfirmation: No description available. ,
WaitingForDataMigrationScheduling: No description available. ,
WaitingForDataMigrationWindow: No description available. ,
MigratingData: No description available. ,
WaitingForCutoverTrigger: No description available. ,
CompletingMigration: No description available. ,
Completed: No description available. ,
CancelingRequestedDBMigrations: No description available. ,
ValidationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
dbDetails:
{
Required: False ,
}
object ,
validationDetails:
{
Description: Details for the validation for migration. ,
Required: False ,
}
{
status:
{
Description: Validation status for migration. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: 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: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations. ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of 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: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: 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: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: Supported option for a migration. ,
Enum:
{
Validate: No description available. ,
Migrate: No description available. ,
ValidateAndMigrate: No description available. ,
}
,
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: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
AzureVM: No description available. ,
PostgreSQLSingleServer: No description available. ,
AWS_RDS: No description available. ,
AWS_AURORA: No description available. ,
AWS_EC2: No description available. ,
GCP_CloudSQL: No description available. ,
GCP_AlloyDB: No description available. ,
GCP_Compute: No description available. ,
EDB: No description available. ,
EDB_Oracle_Server: No description available. ,
EDB_PostgreSQL: No description available. ,
PostgreSQLFlexibleServer: No description available. ,
PostgreSQLCosmosDB: No description available. ,
Huawei_RDS: No description available. ,
Huawei_Compute: No description available. ,
Heroku_PostgreSQL: No description available. ,
Crunchy_PostgreSQL: No description available. ,
ApsaraDB_RDS: No description available. ,
Digital_Ocean_Droplets: No description available. ,
Digital_Ocean_PostgreSQL: No description available. ,
Supabase_PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. ,
Enum:
{
Prefer: No description available. ,
Require: No description available. ,
VerifyCA: No description available. ,
VerifyFull: No description available. ,
}
,
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 flexible 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 flexible 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 LogicalReplicationOnSourceDb, if needed. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
False: No description available. ,
}
,
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_Delete (updated)
Description :  Deletes an existing migration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migrations_Delete",
  "Description": {
    "new": "Deletes an existing migration.",
    "old": "Deletes a migration."
  },
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "Identifier of subscription of target database server.",
        "old": "The subscription ID of the target database server."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "Name of resource group of target database server.",
        "old": "The resource group name of the target database server."
      }
    },
    {
      "#name": "targetDbServerName",
      "Description": {
        "new": "Name of target database server.",
        "old": "The name of the target database server."
      }
    },
    {
      "#name": "migrationName",
      "Description": {
        "new": "Name of migration.",
        "old": "The name of the migration."
      }
    }
  ]
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Migrations_ListByTargetServer (updated)
Description :  Lists all migrations of a target flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migrations_ListByTargetServer",
  "Description": {
    "new": "Lists all migrations of a target flexible server.",
    "old": "List all the migrations on a given target server."
  },
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "Identifier of subscription of target database server.",
        "old": "The subscription ID of the target database server."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "Name of resource group of target database server.",
        "old": "The resource group name of the target database server."
      }
    },
    {
      "#name": "targetDbServerName",
      "Description": {
        "new": "Name of target database server.",
        "old": "The name of the target database server."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "List of migrations.",
        "old": "A list of migration resources."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of migrations.",
            "old": "A list of migration resources."
          },
          "$items": {
            "Description": {
              "new": "Migration.",
              "old": "Represents a migration resource."
            },
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Migration properties.",
                  "old": "Migration resource properties."
                },
                "$properties": [
                  {
                    "#name": "migrationId",
                    "Description": {
                      "new": "Identifier of a migration.",
                      "old": "ID for migration, a GUID."
                    }
                  },
                  {
                    "#name": "currentStatus",
                    "Description": {
                      "new": "Current status of a migration.",
                      "old": "Current status of migration"
                    },
                    "$properties": [
                      {
                        "#name": "state",
                        "Description": {
                          "new": "State of migration.",
                          "old": "State of migration"
                        }
                      },
                      {
                        "#name": "error",
                        "Description": {
                          "new": "Error message, if any, for the migration state.",
                          "old": "Error message, if any, for the migration state"
                        }
                      },
                      {
                        "#name": "currentSubStateDetails",
                        "Description": {
                          "new": "Current migration sub state details.",
                          "old": "Current Migration sub state details."
                        },
                        "$properties": [
                          {
                            "#name": "currentSubState",
                            "Description": {
                              "new": "Substate of migration.",
                              "old": "Migration sub state."
                            }
                          },
                          {
                            "#name": "validationDetails",
                            "Description": {
                              "new": "Details for the validation for migration.",
                              "old": "Details for the validation for migration"
                            },
                            "$properties": [
                              {
                                "#name": "status",
                                "Description": {
                                  "new": "Validation status for migration.",
                                  "old": "Validation status for migration"
                                }
                              },
                              {
                                "#name": "validationStartTimeInUtc",
                                "Description": {
                                  "new": "Start time (UTC) for validation.",
                                  "old": "Validation Start date-time in UTC"
                                }
                              },
                              {
                                "#name": "validationEndTimeInUtc",
                                "Description": {
                                  "new": "End time (UTC) for validation.",
                                  "old": "Validation End date-time in UTC"
                                }
                              },
                              {
                                "#name": "serverLevelValidationDetails",
                                "Description": {
                                  "new": "Details of server level validations.",
                                  "old": "Details of server level validations"
                                },
                                "$items": {
                                  "Description": {
                                    "new": "Validation summary object.",
                                    "old": "Validation summary object"
                                  },
                                  "$properties": [
                                    {
                                      "#name": "type",
                                      "Description": {
                                        "new": "Validation type.",
                                        "old": "Validation type"
                                      }
                                    },
                                    {
                                      "#name": "state",
                                      "Description": {
                                        "new": "Validation status for migration.",
                                        "old": "Validation status for migration"
                                      }
                                    },
                                    {
                                      "#name": "messages",
                                      "Description": {
                                        "new": "Validation messages.",
                                        "old": "Validation messages"
                                      },
                                      "$items": {
                                        "Description": {
                                          "new": "Validation message object.",
                                          "old": "Validation message object"
                                        },
                                        "$properties": [
                                          {
                                            "#name": "state",
                                            "Description": {
                                              "new": "Severity of validation message.",
                                              "old": "Severity of validation message"
                                            }
                                          },
                                          {
                                            "#name": "message",
                                            "Description": {
                                              "new": "Validation message string.",
                                              "old": "Validation message string"
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              },
                              {
                                "#name": "dbLevelValidationDetails",
                                "Description": {
                                  "new": "Details of server level validations.",
                                  "old": "Details of server level validations"
                                },
                                "$items": {
                                  "Description": {
                                    "new": "Validation status summary for a database.",
                                    "old": "Validation status summary for an individual database"
                                  },
                                  "$properties": [
                                    {
                                      "#name": "databaseName",
                                      "Description": {
                                        "new": "Name of database.",
                                        "old": "Name of the database"
                                      }
                                    },
                                    {
                                      "#name": "startedOn",
                                      "Description": {
                                        "new": "Start time of a database level validation.",
                                        "old": "Start date-time of a database level validation"
                                      }
                                    },
                                    {
                                      "#name": "endedOn",
                                      "Description": {
                                        "new": "End time of a database level validation.",
                                        "old": "End date-time of a database level validation"
                                      }
                                    },
                                    {
                                      "#name": "summary",
                                      "Description": {
                                        "new": "Summary of database level validations.",
                                        "old": "Summary of database level validations"
                                      },
                                      "$items": {
                                        "Description": {
                                          "new": "Validation summary object.",
                                          "old": "Validation summary object"
                                        },
                                        "$properties": [
                                          {
                                            "#name": "type",
                                            "Description": {
                                              "new": "Validation type.",
                                              "old": "Validation type"
                                            }
                                          },
                                          {
                                            "#name": "state",
                                            "Description": {
                                              "new": "Validation status for migration.",
                                              "old": "Validation status for migration"
                                            }
                                          },
                                          {
                                            "#name": "messages",
                                            "Description": {
                                              "new": "Validation messages.",
                                              "old": "Validation messages"
                                            },
                                            "$items": {
                                              "Description": {
                                                "new": "Validation message object.",
                                                "old": "Validation message object"
                                              },
                                              "$properties": [
                                                {
                                                  "#name": "state",
                                                  "Description": {
                                                    "new": "Severity of validation message.",
                                                    "old": "Severity of validation message"
                                                  }
                                                },
                                                {
                                                  "#name": "message",
                                                  "Description": {
                                                    "new": "Validation message string.",
                                                    "old": "Validation message string"
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "#name": "migrationInstanceResourceId",
                    "Description": {
                      "new": "Identifier of the private endpoint migration instance.",
                      "old": "ResourceId of the private endpoint migration instance"
                    }
                  },
                  {
                    "#name": "migrationMode",
                    "Description": {
                      "new": "Mode used to perform the migration: Online or Offline.",
                      "old": "There are two types of migration modes Online and Offline"
                    }
                  },
                  {
                    "#name": "migrationOption",
                    "Description": {
                      "new": "Supported option for a migration.",
                      "old": "This indicates the supported Migration option for the migration"
                    }
                  },
                  {
                    "#name": "sourceType",
                    "Description": {
                      "new": "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",
                      "old": "migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL"
                    }
                  },
                  {
                    "#name": "sslMode",
                    "Description": {
                      "new": "SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.",
                      "old": "SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types"
                    }
                  },
                  {
                    "#name": "sourceDbServerMetadata",
                    "Description": {
                      "new": "Metadata of source database server.",
                      "old": "Metadata of the source database server"
                    },
                    "$properties": [
                      {
                        "#name": "location",
                        "Description": {
                          "new": "Location of database server.",
                          "old": "Location of database server"
                        }
                      },
                      {
                        "#name": "version",
                        "Description": {
                          "new": "Major version of PostgreSQL database engine.",
                          "old": "Version for database engine"
                        }
                      },
                      {
                        "#name": "storageMb",
                        "Description": {
                          "new": "Storage size (in MB) for database server.",
                          "old": "Storage size in MB for database server"
                        }
                      },
                      {
                        "#name": "sku",
                        "Description": {
                          "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                          "old": "SKU for the database server. This object is empty for PG single server"
                        },
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                              "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                            }
                          },
                          {
                            "#name": "tier",
                            "Description": {
                              "new": "Tier of the compute assigned to a flexible server.",
                              "old": "The tier of the particular SKU, e.g. Burstable."
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "#name": "targetDbServerMetadata",
                    "Description": {
                      "new": "Metadata of target database server.",
                      "old": "Metadata of the target database server"
                    },
                    "$properties": [
                      {
                        "#name": "location",
                        "Description": {
                          "new": "Location of database server.",
                          "old": "Location of database server"
                        }
                      },
                      {
                        "#name": "version",
                        "Description": {
                          "new": "Major version of PostgreSQL database engine.",
                          "old": "Version for database engine"
                        }
                      },
                      {
                        "#name": "storageMb",
                        "Description": {
                          "new": "Storage size (in MB) for database server.",
                          "old": "Storage size in MB for database server"
                        }
                      },
                      {
                        "#name": "sku",
                        "Description": {
                          "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                          "old": "SKU for the database server. This object is empty for PG single server"
                        },
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server.",
                              "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                            }
                          },
                          {
                            "#name": "tier",
                            "Description": {
                              "new": "Tier of the compute assigned to a flexible server.",
                              "old": "The tier of the particular SKU, e.g. Burstable."
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "#name": "sourceDbServerResourceId",
                    "Description": {
                      "new": "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.",
                      "old": "ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username"
                    }
                  },
                  {
                    "#name": "sourceDbServerFullyQualifiedDomainName",
                    "Description": {
                      "new": "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.",
                      "old": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection"
                    }
                  },
                  {
                    "#name": "targetDbServerResourceId",
                    "Description": {
                      "new": "Identifier of the target database server resource.",
                      "old": "ResourceId of the source database server"
                    }
                  },
                  {
                    "#name": "targetDbServerFullyQualifiedDomainName",
                    "Description": {
                      "new": "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.",
                      "old": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection"
                    }
                  },
                  {
                    "#name": "secretParameters",
                    "Description": {
                      "new": "Migration secret parameters.",
                      "old": "Migration secret parameters"
                    },
                    "$properties": [
                      {
                        "#name": "adminCredentials",
                        "Description": {
                          "new": "Credentials of administrator users for source and target servers.",
                          "old": "Admin credentials for source and target servers"
                        },
                        "$properties": [
                          {
                            "#name": "sourceServerPassword",
                            "Description": {
                              "new": "Password for the user of the source server.",
                              "old": "Password for source server."
                            }
                          },
                          {
                            "#name": "targetServerPassword",
                            "Description": {
                              "new": "Password for the user of the target server.",
                              "old": "Password for target server."
                            }
                          }
                        ]
                      },
                      {
                        "#name": "sourceServerUsername",
                        "Description": {
                          "new": "Gets or sets the name of the user for the source server. This user doesn't need to be an administrator.",
                          "old": "Gets or sets the username for the source server. This user need not be an admin."
                        }
                      },
                      {
                        "#name": "targetServerUsername",
                        "Description": {
                          "new": "Gets or sets the name of the user for the target server. This user doesn't need to be an administrator.",
                          "old": "Gets or sets the username for the target server. This user need not be an admin."
                        }
                      }
                    ]
                  },
                  {
                    "#name": "dbsToMigrate",
                    "Description": {
                      "new": "Names of databases to migrate.",
                      "old": "Number of databases to migrate"
                    }
                  },
                  {
                    "#name": "setupLogicalReplicationOnSourceDbIfNeeded",
                    "Description": {
                      "new": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed.",
                      "old": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed"
                    }
                  },
                  {
                    "#name": "overwriteDbsInTarget",
                    "Description": {
                      "new": "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.",
                      "old": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists."
                    }
                  },
                  {
                    "#name": "migrationWindowStartTimeInUtc",
                    "Description": {
                      "new": "Start time (UTC) for migration window.",
                      "old": "Start time in UTC for migration window"
                    }
                  },
                  {
                    "#name": "migrationWindowEndTimeInUtc",
                    "Description": {
                      "new": "End time (UTC) for migration window.",
                      "old": "End time in UTC for migration window"
                    }
                  },
                  {
                    "#name": "migrateRoles",
                    "Description": {
                      "new": "Indicates if roles and permissions must be migrated.",
                      "old": "To migrate roles and permissions we need to send this flag as True"
                    }
                  },
                  {
                    "#name": "startDataMigration",
                    "Description": {
                      "new": "Indicates if data migration must start right away.",
                      "old": "Indicates whether the data migration should start right away"
                    }
                  },
                  {
                    "#name": "triggerCutover",
                    "Description": {
                      "new": "Indicates if cutover must be triggered for the entire migration.",
                      "old": "To trigger cutover for entire migration we need to send this flag as True"
                    }
                  },
                  {
                    "#name": "dbsToTriggerCutoverOn",
                    "Description": {
                      "new": "When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.",
                      "old": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array"
                    }
                  },
                  {
                    "#name": "cancel",
                    "Description": {
                      "new": "Indicates if cancel must be triggered for the entire migration.",
                      "old": "To trigger cancel for entire migration we need to send this flag as True"
                    }
                  },
                  {
                    "#name": "dbsToCancelMigrationOn",
                    "Description": {
                      "new": "When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.",
                      "old": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array"
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "The link used to get the next page of migrations."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: 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: No description available. ,
WaitingForUserAction: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
ValidationFailed: No description available. ,
CleaningUp: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error message, if any, for the migration state. ,
Required: False ,
}
string ,
currentSubStateDetails:
{
Description: Current migration sub state details. ,
Required: False ,
}
{
currentSubState:
{
Description: Substate of migration. ,
Enum:
{
PerformingPreRequisiteSteps: No description available. ,
WaitingForLogicalReplicationSetupRequestOnSourceDB: No description available. ,
WaitingForDBsToMigrateSpecification: No description available. ,
WaitingForTargetDBOverwriteConfirmation: No description available. ,
WaitingForDataMigrationScheduling: No description available. ,
WaitingForDataMigrationWindow: No description available. ,
MigratingData: No description available. ,
WaitingForCutoverTrigger: No description available. ,
CompletingMigration: No description available. ,
Completed: No description available. ,
CancelingRequestedDBMigrations: No description available. ,
ValidationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
dbDetails:
{
Required: False ,
}
object ,
validationDetails:
{
Description: Details for the validation for migration. ,
Required: False ,
}
{
status:
{
Description: Validation status for migration. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
validationStartTimeInUtc:
{
Description: 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: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dbLevelValidationDetails:
{
Description: Details of server level validations. ,
Required: False ,
}
[
{
databaseName:
{
Description: Name of 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: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
messages:
{
Description: Validation messages. ,
Required: False ,
}
[
{
state:
{
Description: Severity of validation message. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
migrationInstanceResourceId:
{
Description: 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: No description available. ,
Online: No description available. ,
}
,
Required: False ,
}
enum ,
migrationOption:
{
Description: Supported option for a migration. ,
Enum:
{
Validate: No description available. ,
Migrate: No description available. ,
ValidateAndMigrate: No description available. ,
}
,
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: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
AzureVM: No description available. ,
PostgreSQLSingleServer: No description available. ,
AWS_RDS: No description available. ,
AWS_AURORA: No description available. ,
AWS_EC2: No description available. ,
GCP_CloudSQL: No description available. ,
GCP_AlloyDB: No description available. ,
GCP_Compute: No description available. ,
EDB: No description available. ,
EDB_Oracle_Server: No description available. ,
EDB_PostgreSQL: No description available. ,
PostgreSQLFlexibleServer: No description available. ,
PostgreSQLCosmosDB: No description available. ,
Huawei_RDS: No description available. ,
Huawei_Compute: No description available. ,
Heroku_PostgreSQL: No description available. ,
Crunchy_PostgreSQL: No description available. ,
ApsaraDB_RDS: No description available. ,
Digital_Ocean_Droplets: No description available. ,
Digital_Ocean_PostgreSQL: No description available. ,
Supabase_PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
sslMode:
{
Description: SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. ,
Enum:
{
Prefer: No description available. ,
Require: No description available. ,
VerifyCA: No description available. ,
VerifyFull: No description available. ,
}
,
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 flexible 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 flexible 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 LogicalReplicationOnSourceDb, if needed. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
startDataMigration:
{
Description: Indicates if data migration must start right away. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
triggerCutover:
{
Description: Indicates if cutover must be triggered for the entire migration. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
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: No description available. ,
False: No description available. ,
}
,
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. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckMigrationNameAvailability (updated)
Description :  Checks if a proposed migration name is valid and available.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CheckMigrationNameAvailability",
  "Description": {
    "new": "Checks if a proposed migration name is valid and available.",
    "old": "This method checks whether a proposed migration name is valid and available."
  },
  "Summary": {
    "new": "Check the validity and availability of the given name, to assign it to a new migration.",
    "old": "Check migration name validity and availability"
  },
  "$parameters": [
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "Identifier of subscription of target database server.",
        "old": "The subscription ID of the target database server."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "Name of resource group of target database server.",
        "old": "The resource group name of the target database server."
      }
    },
    {
      "#name": "targetDbServerName",
      "Description": {
        "new": "Name of target database server.",
        "old": "The name of the target database server."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required to check if a migration name is valid and available.",
        "old": "The required parameters for checking if a migration name is available."
      },
      "$schema": {
        "Description": {
          "new": "Availability of a migration name.",
          "old": "Represents a migration name's availability."
        },
        "$properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the migration to check for validity and availability.",
              "old": "The resource name to verify."
            }
          },
          {
            "#name": "type",
            "Description": {
              "new": "Type of resource.",
              "old": "The type of the resource."
            }
          },
          {
            "#name": "nameAvailable",
            "Description": {
              "new": "Indicates if the migration name is available.",
              "old": "Indicates whether the resource name is available."
            }
          },
          {
            "#name": "reason",
            "Description": {
              "new": "Migration name availability reason.",
              "old": "Migration name availability reason"
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Availability of a migration name.",
        "old": "Represents a migration name's availability."
      },
      "$properties": [
        {
          "#name": "name",
          "Description": {
            "new": "Name of the migration to check for validity and availability.",
            "old": "The resource name to verify."
          }
        },
        {
          "#name": "type",
          "Description": {
            "new": "Type of resource.",
            "old": "The type of the resource."
          }
        },
        {
          "#name": "nameAvailable",
          "Description": {
            "new": "Indicates if the migration name is available.",
            "old": "Indicates whether the resource name is available."
          }
        },
        {
          "#name": "reason",
          "Description": {
            "new": "Migration name availability reason.",
            "old": "Migration name availability reason"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/checkMigrationNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Identifier of subscription of target database server. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of resource group of target database server. ,
Required: True ,
}
string ,
targetDbServerName:
{
Description: Name of target database 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: No description available. ,
AlreadyExists: No description available. ,
}
,
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: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Migration name availability message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (updated)
Description :  Lists all available REST API operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "Lists all available REST API operations.",
    "old": "Lists all of the available REST API operations."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of resource provider operations.",
        "old": "A list of resource provider operations."
      },
      "$properties": [
        {
          "value": {
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name of the operation being performed on this particular object.",
                  "old": "The name of the operation being performed on this particular object."
                }
              },
              {
                "#name": "display",
                "Description": {
                  "new": "Localized display information for this particular operation or action.",
                  "old": "The localized display information for this particular operation or action."
                },
                "$properties": [
                  {
                    "#name": "provider",
                    "Description": {
                      "new": "Name of the resource provider.",
                      "old": "Operation resource provider name."
                    }
                  },
                  {
                    "#name": "resource",
                    "Description": {
                      "new": "Type of resource on which the operation is performed.",
                      "old": "Resource on which the operation is performed."
                    }
                  },
                  {
                    "#name": "operation",
                    "Description": {
                      "new": "Name of the operation.",
                      "old": "Localized friendly name for the operation."
                    }
                  },
                  {
                    "#name": "description",
                    "Description": {
                      "new": "Description of the operation.",
                      "old": "Operation description."
                    }
                  }
                ]
              },
              {
                "#name": "isDataAction",
                "Description": {
                  "new": "Indicates if the operation is a data action.",
                  "old": "Indicates whether the operation is a data action"
                }
              },
              {
                "#name": "origin",
                "Description": {
                  "new": "Intended executor of the operation.",
                  "old": "The intended executor of the operation."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ 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: No description available. ,
user: No description available. ,
system: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: 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 ,
}
,
]
,
}
,
}
GetPrivateDnsZoneSuffix_Execute (updated)
Description :  Gets the private DNS zone suffix.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetPrivateDnsZoneSuffix_Execute",
  "Description": {
    "new": "Gets the private DNS zone suffix.",
    "old": "Get private DNS zone suffix in the cloud"
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Private DNS suffix.",
        "old": "Represents a resource name availability."
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
$schema:
{
Description: Private DNS suffix. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_Update (updated)
Description :  Approves or rejects a private endpoint connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnection_Update",
  "Description": {
    "new": "Approves or rejects a private endpoint connection.",
    "old": "Approve or reject a private endpoint connection with a given name."
  },
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required to update a private endpoint connection.",
        "old": "The required parameters for updating private endpoint connection."
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to update a private endpoint connection. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_Delete (updated)
Description :  Deletes a private endpoint connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnection_Delete",
  "Description": {
    "new": "Deletes a private endpoint connection.",
    "old": "Deletes a private endpoint connection with a given name."
  }
}

⚼ Request

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByServer (updated)
Description :  Lists all private endpoint connections on a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByServer",
  "Description": {
    "new": "Lists all private endpoint connections on a flexible server.",
    "old": "Gets all private endpoint connections on a server."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of private endpoint connections.",
        "old": "A list of private endpoint connections."
      },
      "$properties": [
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "The URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: 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 ,
}
,
]
,
}
,
}
Replicas_ListByServer (updated)
Description :  Lists all read replicas of a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replicas_ListByServer",
  "Description": {
    "new": "Lists all read replicas of a flexible server.",
    "old": "List all the replicas for a given server."
  },
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "Flexible server.",
            "old": "Represents a server."
          },
          "$properties": [
            {
              "#name": "sku",
              "Description": {
                "new": "Compute tier and size of a flexible server.",
                "old": "The SKU (pricing tier) of the server."
              },
              "$properties": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "Name by which is known a given compute size assigned to a flexible server.",
                    "old": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3."
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Tier of the compute assigned to a flexible server.",
                    "old": "The tier of the particular SKU, e.g. Burstable."
                  }
                }
              ]
            },
            {
              "#name": "identity",
              "Description": {
                "new": "User assigned managed identities assigned to the flexible server.",
                "old": "Describes the identity of the application."
              },
              "$properties": [
                {
                  "#name": "userAssignedIdentities",
                  "Description": {
                    "new": "Map of user assigned managed identities.",
                    "old": "represents user assigned identities map."
                  }
                },
                {
                  "#name": "principalId",
                  "Description": {
                    "new": "Identifier of the object of the service principal associated to the user assigned managed identity.",
                    "old": "the identity principal Id of the server."
                  }
                },
                {
                  "#name": "type",
                  "Description": {
                    "new": "Types of identities associated with a flexible server.",
                    "old": "the types of identities associated with this resource"
                  }
                },
                {
                  "#name": "tenantId",
                  "Description": {
                    "new": "Identifier of the tenant of a flexible server.",
                    "old": "Tenant id of the server."
                  }
                }
              ]
            },
            {
              "#name": "properties",
              "Description": {
                "new": "Properties of a flexible server.",
                "old": "Properties of the server."
              },
              "$properties": [
                {
                  "#name": "administratorLogin",
                  "Description": {
                    "new": "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.",
                    "old": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
                  }
                },
                {
                  "#name": "administratorLoginPassword",
                  "Description": {
                    "new": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.",
                    "old": "The administrator login password (required for server creation)."
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Major version of PostgreSQL database engine.",
                    "old": "PostgreSQL Server version."
                  }
                },
                {
                  "#name": "minorVersion",
                  "Description": {
                    "new": "Minor version of PostgreSQL database engine.",
                    "old": "The minor version of the server."
                  }
                },
                {
                  "#name": "state",
                  "Description": {
                    "new": "Possible states of a flexible server.",
                    "old": "A state of a server that is visible to user."
                  }
                },
                {
                  "#name": "fullyQualifiedDomainName",
                  "Description": {
                    "new": "Fully qualified domain name of a flexible server.",
                    "old": "The fully qualified domain name of a server."
                  }
                },
                {
                  "#name": "storage",
                  "Description": {
                    "new": "Storage properties of a flexible server.",
                    "old": "Storage properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "storageSizeGB",
                      "Description": {
                        "new": "Size of storage assigned to a flexible server.",
                        "old": "Max storage allowed for a server."
                      }
                    },
                    {
                      "#name": "autoGrow",
                      "Description": {
                        "new": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.",
                        "old": "Flag to enable / disable Storage Auto grow for flexible server."
                      }
                    },
                    {
                      "#name": "tier",
                      "Description": {
                        "new": "Storage tier of a flexible server.",
                        "old": "Name of storage tier for IOPS."
                      }
                    },
                    {
                      "#name": "iops",
                      "Description": {
                        "new": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                        "old": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                      }
                    },
                    {
                      "#name": "throughput",
                      "Description": {
                        "new": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS.",
                        "old": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS."
                      }
                    },
                    {
                      "#name": "type",
                      "Description": {
                        "new": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS.",
                        "old": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified"
                      }
                    }
                  ]
                },
                {
                  "#name": "authConfig",
                  "Description": {
                    "new": "Authentication configuration properties of a flexible server.",
                    "old": "AuthConfig properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "activeDirectoryAuth",
                      "Description": {
                        "new": "Indicates if the server supports Microsoft Entra authentication.",
                        "old": "If Enabled, Microsoft Entra authentication is enabled."
                      }
                    },
                    {
                      "#name": "passwordAuth",
                      "Description": {
                        "new": "Indicates if the server supports password based authentication.",
                        "old": "If Enabled, Password authentication is enabled."
                      }
                    },
                    {
                      "#name": "tenantId",
                      "Description": {
                        "new": "Identifier of the tenant of the delegated resource.",
                        "old": "Tenant id of the server."
                      }
                    }
                  ]
                },
                {
                  "#name": "dataEncryption",
                  "Description": {
                    "new": "Data encryption properties of a flexible server.",
                    "old": "Data encryption properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "primaryKeyURI",
                      "Description": {
                        "new": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server.",
                        "old": "URI for the key in keyvault for data encryption of the primary server."
                      }
                    },
                    {
                      "#name": "primaryUserAssignedIdentityId",
                      "Description": {
                        "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server.",
                        "old": "Resource Id for the User assigned identity to be used for data encryption of the primary server."
                      }
                    },
                    {
                      "#name": "geoBackupKeyURI",
                      "Description": {
                        "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                        "old": "URI for the key in keyvault for data encryption for geo-backup of server."
                      }
                    },
                    {
                      "#name": "geoBackupUserAssignedIdentityId",
                      "Description": {
                        "new": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups.",
                        "old": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server."
                      }
                    },
                    {
                      "#name": "type",
                      "Description": {
                        "new": "Data encryption type used by a flexible server.",
                        "old": "Data encryption type to depict if it is System Managed vs Azure Key vault."
                      }
                    },
                    {
                      "#name": "primaryEncryptionKeyStatus",
                      "Description": {
                        "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.",
                        "old": "Primary encryption key status for Data encryption enabled server."
                      }
                    },
                    {
                      "#name": "geoBackupEncryptionKeyStatus",
                      "Description": {
                        "new": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.",
                        "old": "Geo-backup encryption key status for Data encryption enabled server."
                      }
                    }
                  ]
                },
                {
                  "#name": "backup",
                  "Description": {
                    "new": "Backup properties of a flexible server.",
                    "old": "Backup properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "backupRetentionDays",
                      "Description": {
                        "new": "Backup retention days for the flexible server.",
                        "old": "Backup retention days for the server."
                      }
                    },
                    {
                      "#name": "geoRedundantBackup",
                      "Description": {
                        "new": "Indicates if the server is configured to create geographically redundant backups.",
                        "old": "A value indicating whether Geo-Redundant backup is enabled on the server."
                      }
                    },
                    {
                      "#name": "earliestRestoreDate",
                      "Description": {
                        "new": "Earliest restore point time (ISO8601 format) for a flexible server.",
                        "old": "The earliest restore point time (ISO8601 format) for server."
                      }
                    }
                  ]
                },
                {
                  "#name": "network",
                  "Description": {
                    "new": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer.",
                    "old": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server."
                  },
                  "$properties": [
                    {
                      "#name": "publicNetworkAccess",
                      "Description": {
                        "new": "Indicates if public network access is enabled or not.",
                        "old": "public network access is enabled or not"
                      }
                    },
                    {
                      "#name": "delegatedSubnetResourceId",
                      "Description": {
                        "new": "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.",
                        "old": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                      }
                    },
                    {
                      "#name": "privateDnsZoneArmResourceId",
                      "Description": {
                        "new": "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.",
                        "old": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone."
                      }
                    }
                  ]
                },
                {
                  "#name": "highAvailability",
                  "Description": {
                    "new": "High availability properties of a flexible server.",
                    "old": "High availability properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "mode",
                      "Description": {
                        "new": "High availability mode for a flexible server.",
                        "old": "The HA mode for the server."
                      }
                    },
                    {
                      "#name": "state",
                      "Description": {
                        "new": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.",
                        "old": "A state of a HA server that is visible to user."
                      }
                    },
                    {
                      "#name": "standbyAvailabilityZone",
                      "Description": {
                        "new": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant.",
                        "old": "availability zone information of the standby."
                      }
                    }
                  ]
                },
                {
                  "#name": "maintenanceWindow",
                  "Description": {
                    "new": "Maintenance window properties of a flexible server.",
                    "old": "Maintenance window properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "customWindow",
                      "Description": {
                        "new": "Indicates whether custom window is enabled or disabled.",
                        "old": "indicates whether custom window is enabled or disabled"
                      }
                    },
                    {
                      "#name": "startHour",
                      "Description": {
                        "new": "Start hour to be used for maintenance window.",
                        "old": "start hour for maintenance window"
                      }
                    },
                    {
                      "#name": "startMinute",
                      "Description": {
                        "new": "Start minute to be used for maintenance window.",
                        "old": "start minute for maintenance window"
                      }
                    },
                    {
                      "#name": "dayOfWeek",
                      "Description": {
                        "new": "Day of the week to be used for maintenance window.",
                        "old": "day of week for maintenance window"
                      }
                    }
                  ]
                },
                {
                  "#name": "sourceServerResourceId",
                  "Description": {
                    "new": "Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.",
                    "old": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server"
                  }
                },
                {
                  "#name": "pointInTimeUTC",
                  "Description": {
                    "new": "Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.",
                    "old": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'."
                  }
                },
                {
                  "#name": "availabilityZone",
                  "Description": {
                    "new": "Availability zone of a flexible server.",
                    "old": "availability zone information of the server."
                  }
                },
                {
                  "#name": "replicationRole",
                  "Description": {
                    "new": "Role of the server in a replication set.",
                    "old": "Replication role of the server"
                  }
                },
                {
                  "#name": "replicaCapacity",
                  "Description": {
                    "new": "Maximum number of read replicas allowed for a flexible server.",
                    "old": "Replicas allowed for a server."
                  }
                },
                {
                  "#name": "replica",
                  "Description": {
                    "new": "Read replica properties of a flexible server. Required only in case that you want to promote a server.",
                    "old": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server."
                  },
                  "$properties": [
                    {
                      "#name": "role",
                      "Description": {
                        "new": "Role of the server in a replication set.",
                        "old": "Used to indicate role of the server in replication set."
                      }
                    },
                    {
                      "#name": "capacity",
                      "Description": {
                        "new": "Maximum number of read replicas allowed for a flexible server.",
                        "old": "Replicas allowed for a server."
                      }
                    },
                    {
                      "#name": "replicationState",
                      "Description": {
                        "new": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible  values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating",
                        "old": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring"
                      }
                    },
                    {
                      "#name": "promoteMode",
                      "Description": {
                        "new": "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.",
                        "old": "Sets the promote mode for a replica server. This is a write only property."
                      }
                    },
                    {
                      "#name": "promoteOption",
                      "Description": {
                        "new": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.",
                        "old": "Sets the promote options for a replica server. This is a write only property."
                      }
                    }
                  ]
                },
                {
                  "#name": "createMode",
                  "Description": {
                    "new": "Creation mode of a new flexible server.",
                    "old": "The mode to create a new PostgreSQL server."
                  }
                },
                {
                  "#name": "privateEndpointConnections",
                  "Description": {
                    "new": "List of private endpoint connections associated with the specified flexible server.",
                    "old": "List of private endpoint connections associated with the specified resource."
                  }
                },
                {
                  "#name": "cluster",
                  "Description": {
                    "new": "Cluster properties of a flexible server.",
                    "old": "Cluster properties of a server."
                  },
                  "$properties": [
                    {
                      "#name": "clusterSize",
                      "Description": {
                        "new": "Number of nodes assigned to the elastic cluster.",
                        "old": "The node count for the cluster."
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of flexible servers ,
Required: False ,
}
[
{
sku:
{
Description: Compute tier and size of a flexible server. ,
Required: False ,
}
{
name:
{
Description: Name by which is known a given compute size assigned to a flexible server. ,
Required: True ,
}
string ,
tier:
{
Description: Tier of the compute assigned to a flexible server. ,
Enum:
{
Burstable: No description available. ,
GeneralPurpose: No description available. ,
MemoryOptimized: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: User assigned managed identities assigned to the flexible 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 flexible server. ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of a flexible server. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a flexible 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: No description available. ,
16: No description available. ,
15: No description available. ,
14: No description available. ,
13: No description available. ,
12: No description available. ,
11: No description available. ,
}
,
Required: False ,
}
enum ,
minorVersion:
{
Description: Minor version of PostgreSQL database engine. ,
Required: False ,
}
string ,
state:
{
Description: Possible states of a flexible server. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Restarting: No description available. ,
Inaccessible: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: Fully qualified domain name of a flexible server. ,
Required: False ,
}
string ,
storage:
{
Description: Storage properties of a flexible server. ,
Required: False ,
}
{
storageSizeGB:
{
Description: Size of storage assigned to a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
autoGrow:
{
Description: Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: Storage tier of a flexible server. ,
Enum:
{
P1: No description available. ,
P2: No description available. ,
P3: No description available. ,
P4: No description available. ,
P6: No description available. ,
P10: No description available. ,
P15: No description available. ,
P20: No description available. ,
P30: No description available. ,
P40: No description available. ,
P50: No description available. ,
P60: No description available. ,
P70: No description available. ,
P80: No description available. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: 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 flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. ,
Enum:
{
Premium_LRS: No description available. ,
PremiumV2_LRS: No description available. ,
UltraSSD_LRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authConfig:
{
Description: Authentication configuration properties of a flexible server. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Description: Indicates if the server supports Microsoft Entra authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Description: Indicates if the server supports password based authentication. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Identifier of the tenant of the delegated resource. ,
Required: False ,
}
string ,
}
,
dataEncryption:
{
Description: Data encryption properties of a flexible server. ,
Required: False ,
}
{
primaryKeyURI:
{
Description: URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible 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 flexible 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 flexible 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 flexible server that is configured to support geographically redundant backups. ,
Required: False ,
}
string ,
type:
{
Description: Data encryption type used by a flexible server. ,
Enum:
{
SystemManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
geoBackupEncryptionKeyStatus:
{
Description: Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
backup:
{
Description: Backup properties of a flexible server. ,
Required: False ,
}
{
backupRetentionDays:
{
Description: Backup retention days for the flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
geoRedundantBackup:
{
Description: Indicates if the server is configured to create geographically redundant backups. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: Earliest restore point time (ISO8601 format) for a flexible server. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
network:
{
Description: Network properties of a flexible 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 flexible server. ,
Required: False ,
}
{
mode:
{
Description: High availability mode for a flexible server. ,
Enum:
{
Disabled: No description available. ,
ZoneRedundant: No description available. ,
SameZone: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
}
,
Required: False ,
}
enum ,
standbyAvailabilityZone:
{
Description: Availability zone 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 flexible 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 flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. ,
Format: date-time ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability zone of a flexible server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Role of the server in a replication set. ,
Enum:
{
None: No description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
replicaCapacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replica:
{
Description: Read replica properties of a flexible 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 description available. ,
Primary: No description available. ,
AsyncReplica: No description available. ,
GeoAsyncReplica: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: Maximum number of read replicas allowed for a flexible server. ,
Format: int32 ,
Required: False ,
}
integer ,
replicationState:
{
Description: Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating ,
Enum:
{
Active: No description available. ,
Catchup: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Broken: No description available. ,
Reconfiguring: No description available. ,
}
,
Required: False ,
}
enum ,
promoteMode:
{
Description: 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: No description available. ,
switchover: No description available. ,
}
,
Required: False ,
}
enum ,
promoteOption:
{
Description: Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. ,
Enum:
{
planned: No description available. ,
forced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Creation mode of a new flexible server. ,
Enum:
{
Default: No description available. ,
Create: No description available. ,
Update: No description available. ,
PointInTimeRestore: No description available. ,
GeoRestore: No description available. ,
Replica: No description available. ,
ReviveDropped: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the specified flexible 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 flexible server. ,
Required: False ,
}
{
clusterSize:
{
Description: Number of nodes assigned to the elastic cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LogFiles_ListByServer (updated)
Description :  Lists all captured logs for download in a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LogFiles_ListByServer",
  "Description": {
    "new": "Lists all captured logs for download in a flexible server.",
    "old": "List all the server log files in a given server."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of log files.",
        "old": "A List of logFiles."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of log files in a flexible server.",
            "old": "The list of logFiles in a server"
          },
          "$items": {
            "Description": {
              "new": "Log file.",
              "old": "Represents a logFile."
            },
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Properties of a log file.",
                  "old": "The properties of a logFile."
                },
                "$properties": [
                  {
                    "#name": "sizeInKb",
                    "Description": {
                      "new": "Size (in KB) of the log file.",
                      "old": "The size in kb of the logFile."
                    }
                  },
                  {
                    "#name": "type",
                    "Description": {
                      "new": "Type of log file. Can be 'ServerLogs' or 'UpgradeLogs'.",
                      "old": "Type of the log file."
                    }
                  },
                  {
                    "#name": "url",
                    "Description": {
                      "new": "URL to download the log file from.",
                      "old": "The url to download the log file from."
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "The link used to get the next page of operations."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of log files in a flexible server. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a log file. ,
Required: False ,
}
{
createdTime:
{
Description: Creation timestamp of the log file. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified timestamp of the log file. ,
Format: date-time ,
Required: False ,
}
string ,
sizeInKb:
{
Description: Size (in KB) of the log file. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: Type of log file. Can be 'ServerLogs' or 'UpgradeLogs'. ,
Required: False ,
}
string ,
url:
{
Description: URL to download the log file from. ,
Required: False ,
}
string ,
}
,
}
,
]
,
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_Restart (updated)
Description :  Restarts PostgreSQL database engine in a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Restart",
  "Description": {
    "new": "Restarts PostgreSQL database engine in a flexible server.",
    "old": "Restarts a server."
  },
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters to restart a flexible server.",
        "old": "The parameters for restarting a server."
      },
      "$schema": {
        "Description": {
          "new": "PostgreSQL database engine restart parameters.",
          "old": "Represents server restart parameters."
        },
        "$properties": [
          {
            "#name": "restartWithFailover",
            "Description": {
              "new": "Indicates if restart the PostgreSQL database engine should failover or switch over from primary to standby. This only works if flexible server has high availability enabled.",
              "old": "Indicates whether to restart the server with failover."
            }
          }
        ]
      }
    }
  ]
}

⚼ 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 flexible 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 flexible server has high availability enabled. ,
Required: False ,
}
boolean ,
failoverMode:
{
Description: Failover mode. ,
Enum:
{
PlannedFailover: No description available. ,
ForcedFailover: No description available. ,
PlannedSwitchover: No description available. ,
ForcedSwitchover: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Start (updated)
Description :  Starts a stopped flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_Start",
  "Description": {
    "new": "Starts a stopped flexible server.",
    "old": "Starts a server."
  }
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Servers_Stop",
  "Description": {
    "new": "Stops a flexible server.",
    "old": "Stops a server."
  }
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerThreatProtectionSettings_ListByServer (updated)
Description :  Lists state of advanced threat protection settings for a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerThreatProtectionSettings_ListByServer",
  "Description": {
    "new": "Lists state of advanced threat protection settings for a flexible server.",
    "old": "Get a list of server's Threat Protection state."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of advanced threat protection settings for a flexible server.",
        "old": "A list of the server's Advanced Threat Protection settings."
      },
      "$properties": [
        {
          "value": {
            "Description": {
              "new": "Advanced threat protection settings of the flexible server.",
              "old": "Server's Advanced Threat Protection settings."
            },
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Advanced threat protection properties.",
                  "old": "Advanced Threat Protection properties."
                },
                "$properties": [
                  {
                    "#name": "state",
                    "Description": {
                      "new": "Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server.",
                      "old": "Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server."
                    }
                  },
                  {
                    "#name": "creationTime",
                    "Description": {
                      "new": "Specifies the creation time (UTC) of the policy.",
                      "old": "Specifies the UTC creation time of the policy."
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ 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 flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerThreatProtectionSettings_Get (updated)
Description :  Gets state of advanced threat protection settings for a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerThreatProtectionSettings_Get",
  "Description": {
    "new": "Gets state of advanced threat protection settings for a flexible server.",
    "old": "Get a server's Advanced Threat Protection settings."
  },
  "$parameters": [
    {
      "#name": "threatProtectionName",
      "Description": {
        "new": "Name of the advanced threat protection settings.",
        "old": "The name of the Threat Protection state."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Advanced threat protection settings of the flexible server.",
        "old": "Server's Advanced Threat Protection settings."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Advanced threat protection properties.",
            "old": "Advanced Threat Protection properties."
          },
          "$properties": [
            {
              "#name": "state",
              "Description": {
                "new": "Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server.",
                "old": "Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server."
              }
            },
            {
              "#name": "creationTime",
              "Description": {
                "new": "Specifies the creation time (UTC) of the policy.",
                "old": "Specifies the UTC creation time of the policy."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ 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 flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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": [
    {
      "#name": "threatProtectionName",
      "Description": {
        "new": "Name of the advanced threat protection settings.",
        "old": "The name of the Threat Protection state."
      }
    },
    {
      "parameters": {
        "Description": {
          "new": "Advanced threat protection settings of the flexible server.",
          "old": "Server's Advanced Threat Protection settings."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Advanced threat protection properties.",
              "old": "Advanced Threat Protection properties."
            },
            "$properties": [
              {
                "#name": "state",
                "Description": {
                  "new": "Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server.",
                  "old": "Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server."
                }
              },
              {
                "#name": "creationTime",
                "Description": {
                  "new": "Specifies the creation time (UTC) of the policy.",
                  "old": "Specifies the UTC creation time of the policy."
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Advanced threat protection settings of the flexible server.",
        "old": "Server's Advanced Threat Protection settings."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Advanced threat protection properties.",
            "old": "Advanced Threat Protection properties."
          },
          "$properties": [
            {
              "#name": "state",
              "Description": {
                "new": "Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server.",
                "old": "Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server."
              }
            },
            {
              "#name": "creationTime",
              "Description": {
                "new": "Specifies the creation time (UTC) of the policy.",
                "old": "Specifies the UTC creation time of the policy."
              }
            }
          ]
        }
      ]
    },
    "201": {
      "Description": {
        "new": "Advanced threat protection settings of the flexible server.",
        "old": "Server's Advanced Threat Protection settings."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Advanced threat protection properties.",
            "old": "Advanced Threat Protection properties."
          },
          "$properties": [
            {
              "#name": "state",
              "Description": {
                "new": "Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server.",
                "old": "Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server."
              }
            },
            {
              "#name": "creationTime",
              "Description": {
                "new": "Specifies the creation time (UTC) of the policy.",
                "old": "Specifies the UTC creation time of the policy."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ 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 flexible 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 flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the creation time (UTC) of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Advanced threat protection properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
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 flexible server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the creation time (UTC) of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}
TuningOptions_Get (updated)
Description :  Gets the tuning options of a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TuningOptions_Get",
  "Description": {
    "new": "Gets the tuning options of a flexible server.",
    "old": "Retrieve the tuning option on a server."
  },
  "$parameters": [
    {
      "#name": "tuningOption",
      "Description": {
        "new": "Name of the tuning option.",
        "old": "The name of the tuning option."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Impact on some metric if this recommended action is applied.",
        "old": "Stores property that features impact on some metric if this recommended action is applied."
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
$schema:
{
Description: Impact on some metric if this recommended action is applied. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TuningIndex_ListRecommendations (updated)
Description :  Lists available recommendations produced by index tuning.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TuningIndex_ListRecommendations",
  "Description": {
    "new": "Lists available recommendations produced by index tuning.",
    "old": "Retrieve the list of available tuning index recommendations."
  },
  "$parameters": [
    {
      "#name": "tuningOption",
      "Description": {
        "new": "Name of the tuning option.",
        "old": "The name of the tuning option."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "List of available index recommendations.",
        "old": "A list of available index recommendations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of available index recommendations.",
            "old": "A list of available index recommendations."
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "initialRecommendedTime",
                  "Description": {
                    "new": "Creation time (UTC) of this recommendation.",
                    "old": "Creation time of this recommendation in UTC date-time string format."
                  }
                },
                {
                  "#name": "lastRecommendedTime",
                  "Description": {
                    "new": "Last time (UTC) that this recommendation was produced.",
                    "old": "The last refresh of this recommendation in UTC date-time string format."
                  }
                },
                {
                  "#name": "timesRecommended",
                  "Description": {
                    "new": "Number of times this recommendation has been produced.",
                    "old": "The number of times this recommendation has encountered."
                  }
                },
                {
                  "#name": "improvedQueryIds",
                  "Description": {
                    "new": "List of identifiers for all queries identified as targets for improvement if the recommendation is applied. The list is only populated for CREATE INDEX recommendations.",
                    "old": "The ImprovedQueryIds. The list will only be populated for CREATE INDEX recommendations."
                  }
                },
                {
                  "#name": "implementationDetails",
                  "Description": {
                    "new": "Implementation details for the recommended action.",
                    "old": "Stores implementation details for the recommended action."
                  },
                  "$properties": [
                    {
                      "#name": "method",
                      "Description": {
                        "new": "Method of implementation for recommended action.",
                        "old": "Method of implementation for recommended action"
                      }
                    },
                    {
                      "#name": "script",
                      "Description": {
                        "new": "Implementation script for the recommended action.",
                        "old": "Implementation script for the recommended action"
                      }
                    }
                  ]
                },
                {
                  "#name": "analyzedWorkload",
                  "Description": {
                    "new": "Workload information for the recommended action.",
                    "old": "Stores workload information for the recommended action."
                  },
                  "$properties": [
                    {
                      "#name": "startTime",
                      "Description": {
                        "new": "Start time (UTC) of the workload analyzed.",
                        "old": "Workload start time in UTC date-time string format."
                      }
                    },
                    {
                      "#name": "endTime",
                      "Description": {
                        "new": "End time (UTC) of the workload analyzed.",
                        "old": "Workload end time in UTC date-time string format."
                      }
                    },
                    {
                      "#name": "queryCount",
                      "Description": {
                        "new": "Number of queries from the workload that were examined to produce this recommendation. For DROP INDEX recommendations it's 0 (zero).",
                        "old": "Workload query examined count. For DROP INDEX will be 0."
                      }
                    }
                  ]
                },
                {
                  "#name": "estimatedImpact",
                  "Description": {
                    "new": "Estimated impact of this recommended action.",
                    "old": "The estimated impact of this recommended action"
                  },
                  "$items": {
                    "Description": {
                      "new": "Impact on some metric if this recommended action is applied.",
                      "old": "Stores property that features impact on some metric if this recommended action is applied."
                    },
                    "$properties": [
                      {
                        "#name": "dimensionName",
                        "Description": {
                          "new": "Dimension name.",
                          "old": "Dimension name"
                        }
                      },
                      {
                        "#name": "unit",
                        "Description": {
                          "new": "Dimension unit.",
                          "old": "Dimension unit"
                        }
                      },
                      {
                        "#name": "queryId",
                        "Description": {
                          "new": "Optional property that can be used to store the identifier of the query, if the metric is for a specific query.",
                          "old": "Optional property that can be used to store the QueryId if the metric is for a specific query."
                        }
                      },
                      {
                        "#name": "absoluteValue",
                        "Description": {
                          "new": "Absolute value.",
                          "old": "Absolute value"
                        }
                      }
                    ]
                  }
                },
                {
                  "#name": "details",
                  "Description": {
                    "new": "Recommendation details for the recommended action.",
                    "old": "Stores recommendation details for the recommended action."
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/recommendations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
tuningOption:
{
Description: Name of the tuning option. ,
Required: True ,
}
string ,
recommendationType:
{
Description: Recommendations list filter. Retrieves recommendations based on type. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of available index recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of IndexRecommendationResource. ,
Required: False ,
}
{
initialRecommendedTime:
{
Description: Creation time (UTC) of this recommendation. ,
Format: date-time ,
Required: False ,
}
string ,
lastRecommendedTime:
{
Description: Last time (UTC) that this recommendation was produced. ,
Format: date-time ,
Required: False ,
}
string ,
timesRecommended:
{
Description: Number of times this recommendation has been produced. ,
Format: int32 ,
Required: False ,
}
integer ,
improvedQueryIds:
{
Description: List of identifiers for all queries identified as targets for improvement if the recommendation is applied. The list is only populated for CREATE INDEX recommendations. ,
Required: False ,
}
[
integer ,
]
,
recommendationReason:
{
Description: Reason for this recommendation. ,
Required: False ,
}
string ,
recommendationType:
{
Description: Type for this recommendation. ,
Enum:
{
CreateIndex: No description available. ,
DropIndex: No description available. ,
ReIndex: No description available. ,
}
,
Required: False ,
}
enum ,
implementationDetails:
{
Description: Implementation details for the recommended action. ,
Required: False ,
}
{
method:
{
Description: Method of implementation for recommended action. ,
Required: False ,
}
string ,
script:
{
Description: Implementation script for the recommended action. ,
Required: False ,
}
string ,
}
,
analyzedWorkload:
{
Description: Workload information for the recommended action. ,
Required: False ,
}
{
startTime:
{
Description: Start time (UTC) of the workload analyzed. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time (UTC) of the workload analyzed. ,
Format: date-time ,
Required: False ,
}
string ,
queryCount:
{
Description: Number of queries from the workload that were examined to produce this recommendation. For DROP INDEX recommendations it's 0 (zero). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
estimatedImpact:
{
Description: Estimated impact of this recommended action. ,
Required: False ,
}
[
{
dimensionName:
{
Description: Dimension name. ,
Required: False ,
}
string ,
unit:
{
Description: Dimension unit. ,
Required: False ,
}
string ,
queryId:
{
Description: Optional property that can be used to store the identifier of the query, if the metric is for a specific query. ,
Format: int64 ,
Required: False ,
}
integer ,
absoluteValue:
{
Description: Absolute value. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
details:
{
Description: Recommendation details for the recommended action. ,
Required: False ,
}
{
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
schema:
{
Description: Schema name. ,
Required: False ,
}
string ,
table:
{
Description: Table name. ,
Required: False ,
}
string ,
indexType:
{
Description: Index type. ,
Required: False ,
}
string ,
indexName:
{
Description: Index name. ,
Required: False ,
}
string ,
indexColumns:
{
Description: Index columns. ,
Required: False ,
}
[
string ,
]
,
includedColumns:
{
Description: Index included columns. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: 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 ,
}
,
]
,
}
,
}
TuningConfiguration_Enable (updated)
Description :  Enables the config tuning.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TuningConfiguration_Enable",
  "$parameters": [
    {
      "#name": "tuningOption",
      "Description": {
        "new": "Name of the tuning option.",
        "old": "The name of the tuning option."
      }
    }
  ]
}

⚼ Request

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TuningConfiguration_Disable (updated)
Description :  Disables the config tuning.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TuningConfiguration_Disable",
  "$parameters": [
    {
      "#name": "tuningOption",
      "Description": {
        "new": "Name of the tuning option.",
        "old": "The name of the tuning option."
      }
    }
  ]
}

⚼ Request

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TuningConfiguration_StartSession (updated)
Description :  Starts up the config tuning session.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TuningConfiguration_StartSession",
  "$parameters": [
    {
      "#name": "tuningOption",
      "Description": {
        "new": "Name of the tuning option.",
        "old": "The name of the tuning option."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/startSession
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
tuningOption:
{
Description: Name of the tuning option. ,
Required: True ,
}
string ,
configTuningRequest:
{
Description: The parameters for tuning request. ,
Required: True ,
}
{
serverName:
{
Description: The name of server. ,
Required: False ,
}
string ,
allowServerRestarts:
{
Description: Indicates whether PG should be restarted during a tuning session. ,
Required: False ,
}
boolean ,
targetImprovementMetric:
{
Description: The target metric the tuning session is trying to improve. ,
Required: False ,
}
string ,
configTuningUsageMode:
{
Description: The mode with which the feature will be enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TuningConfiguration_StopSession (updated)
Description :  Stops the config tuning session.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TuningConfiguration_StopSession",
  "$parameters": [
    {
      "#name": "tuningOption",
      "Description": {
        "new": "Name of the tuning option.",
        "old": "The name of the tuning option."
      }
    }
  ]
}

⚼ Request

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TuningConfiguration_ListSessions (updated)
Description :  Gets up the config tuning session status.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TuningConfiguration_ListSessions",
  "$parameters": [
    {
      "#name": "tuningOption",
      "Description": {
        "new": "Name of the tuning option.",
        "old": "The name of the tuning option."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "List of tuning configuration sessions.",
        "old": "A list of tuning configuration sessions."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of tuning configuration sessions.",
            "old": "A list of tuning configuration sessions."
          },
          "$items": {
            "$properties": [
              {
                "#name": "sessionStartTime",
                "Description": {
                  "new": "Start time of the tuning session.",
                  "old": "the tuning session start time."
                }
              },
              {
                "#name": "sessionId",
                "Description": {
                  "new": "Identifier of the tuning session.",
                  "old": "Session id."
                }
              },
              {
                "#name": "status",
                "Description": {
                  "new": "Status of the tuning session.",
                  "old": "The status of the tuning session."
                }
              },
              {
                "#name": "preTuningAqr",
                "Description": {
                  "new": "Average query runtime before tuning starts.",
                  "old": "The pre tuning aqr."
                }
              },
              {
                "#name": "postTuningAqr",
                "Description": {
                  "new": "Average query runtime after tuning completes.",
                  "old": "The post tuning aqr."
                }
              },
              {
                "#name": "preTuningTps",
                "Description": {
                  "new": "Transactions per second before tuning starts.",
                  "old": "The pre tuning tps."
                }
              },
              {
                "#name": "postTuningTps",
                "Description": {
                  "new": "Transactions per second after tuning completes.",
                  "old": "The post tuning tps."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of tuning configuration sessions. ,
Required: False ,
}
[
{
sessionStartTime:
{
Description: Start time of the tuning session. ,
Required: False ,
}
string ,
sessionId:
{
Description: Identifier of the tuning session. ,
Required: False ,
}
string ,
status:
{
Description: Status of the tuning session. ,
Required: False ,
}
string ,
preTuningAqr:
{
Description: Average query runtime before tuning starts. ,
Required: False ,
}
string ,
postTuningAqr:
{
Description: Average query runtime after tuning completes. ,
Required: False ,
}
string ,
preTuningTps:
{
Description: Transactions per second before tuning starts. ,
Required: False ,
}
string ,
postTuningTps:
{
Description: Transactions per second after tuning completes. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
TuningConfiguration_ListSessionDetails (updated)
Description :  Gets the session details of a config tuning session.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TuningConfiguration_ListSessionDetails",
  "$parameters": [
    {
      "#name": "tuningOption",
      "Description": {
        "new": "Name of the tuning option.",
        "old": "The name of the tuning option."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: A list of details of the session. ,
Required: False ,
}
[
{
iterationId:
{
Description: Iteration id. ,
Required: False ,
}
string ,
sessionId:
{
Description: Session id. ,
Required: False ,
}
string ,
appliedConfiguration:
{
Description: Applied configuration for the iteration. ,
Required: False ,
}
string ,
iterationStartTime:
{
Description: Iteration start time. ,
Required: False ,
}
string ,
averageQueryRuntimeMs:
{
Description: The aqr for the iteration. ,
Required: False ,
}
string ,
transactionsPerSecond:
{
Description: The tps for the iteration. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: 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 ,
}
,
]
,
}
,
}
TuningOptions_ListByServer (updated)
Description :  Lists the tuning options of a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TuningOptions_ListByServer",
  "Description": {
    "new": "Lists the tuning options of a flexible server.",
    "old": "Retrieve the list of available tuning options."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of server tuning options.",
        "old": "A list of server tuning options."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of available tuning options.",
            "old": "A list of available tuning options."
          },
          "$items": {
            "Description": {
              "new": "Impact on some metric if this recommended action is applied.",
              "old": "Stores property that features impact on some metric if this recommended action is applied."
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of available tuning options. ,
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 ,
}
,
]
,
}
,
}
VirtualEndpoints_Create (updated)
Description :  Creates a pair of virtual endpoints for a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualEndpoints_Create",
  "Description": {
    "new": "Creates a pair of virtual endpoints for a flexible server.",
    "old": "Creates a new virtual endpoint for PostgreSQL flexible server."
  },
  "$parameters": [
    {
      "#name": "virtualEndpointName",
      "Description": {
        "new": "Base name of the virtual endpoints.",
        "old": "The name of the virtual endpoint."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required to create or update a pair of virtual endpoints.",
        "old": "The required parameters for creating or updating virtual endpoints."
      },
      "$schema": {
        "Description": {
          "new": "Pair of virtual endpoints for a flexible server.",
          "old": "Represents a virtual endpoint for a server."
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Pair of virtual endpoints for a flexible server.",
        "old": "Represents a virtual endpoint for a server."
      }
    },
    "201": {
      "Description": {
        "new": "Pair of virtual endpoints for a flexible server.",
        "old": "Represents a virtual endpoint for a server."
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
virtualEndpointName:
{
Description: Base name of the virtual endpoints. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to create or update a pair of virtual endpoints. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: Pair of virtual endpoints for a flexible server. ,
}
object ,
}

⚐ Response (201)

{
$schema:
{
Description: Pair of virtual endpoints for a flexible server. ,
}
object ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualEndpoints_Update (updated)
Description :  Updates a pair of virtual endpoints for a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualEndpoints_Update",
  "Description": {
    "new": "Updates a pair of virtual endpoints for a flexible server.",
    "old": "Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition."
  },
  "$parameters": [
    {
      "#name": "virtualEndpointName",
      "Description": {
        "new": "Base name of the virtual endpoints.",
        "old": "The name of the virtual endpoint."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Parameters required to update a pair of virtual endpoints.",
        "old": "The required parameters for updating a server."
      },
      "$schema": {
        "Description": {
          "new": "Pair of virtual endpoints for a flexible server.",
          "old": "Represents a virtual endpoint for a server."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Properties of the pair of virtual endpoints.",
              "old": "Properties of the virtual endpoint resource."
            },
            "$properties": [
              {
                "#name": "endpointType",
                "Description": {
                  "new": "Type of endpoint for the virtual endpoints.",
                  "old": "The endpoint type for the virtual endpoint."
                }
              },
              {
                "#name": "members",
                "Description": {
                  "new": "List of flexible servers that one of the virtual endpoints can refer to.",
                  "old": "List of members for a virtual endpoint"
                },
                "$items": {
                  "Description": {
                    "new": "Flexible server that one of the virtual endpoints can refer to.",
                    "old": "Member for the virtual endpoint."
                  }
                }
              },
              {
                "#name": "virtualEndpoints",
                "Description": {
                  "new": "List of virtual endpoints for a flexible server.",
                  "old": "List of virtual endpoints for a server"
                },
                "$items": {
                  "Description": {
                    "new": "Virtual endpoints for a flexible server.",
                    "old": "Virtual endpoint for a server."
                  }
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Pair of virtual endpoints for a flexible server.",
        "old": "Represents a virtual endpoint for a server."
      }
    }
  }
}

⚼ 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: No description available. ,
}
,
Required: False ,
}
enum ,
members:
{
Description: List of flexible servers that one of the virtual endpoints can refer to. ,
Required: False ,
}
[
string ,
]
,
virtualEndpoints:
{
Description: List of virtual endpoints for a flexible server. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: Pair of virtual endpoints for a flexible server. ,
}
object ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualEndpoints_Delete (updated)
Description :  Deletes a pair of virtual endpoints.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualEndpoints_Delete",
  "Description": {
    "new": "Deletes a pair of virtual endpoints.",
    "old": "Deletes a virtual endpoint."
  },
  "$parameters": [
    {
      "#name": "virtualEndpointName",
      "Description": {
        "new": "Base name of the virtual endpoints.",
        "old": "The name of the virtual endpoint."
      }
    }
  ]
}

⚼ Request

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "VirtualEndpoints_Get",
  "Description": {
    "new": "Gets information about a pair of virtual endpoints.",
    "old": "Gets information about a virtual endpoint."
  },
  "$parameters": [
    {
      "#name": "virtualEndpointName",
      "Description": {
        "new": "Base name of the virtual endpoints.",
        "old": "The name of the virtual endpoint."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Pair of virtual endpoints for a flexible server.",
        "old": "Represents a virtual endpoint for a server."
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
$schema:
{
Description: Pair of virtual endpoints for a flexible server. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualEndpoints_ListByServer (updated)
Description :  Lists pair of virtual endpoints associated to a flexible server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VirtualEndpoints_ListByServer",
  "Description": {
    "new": "Lists pair of virtual endpoints associated to a flexible server.",
    "old": "List all the servers in a given resource group."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of virtual endpoints.",
        "old": "A list of virtual endpoints."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of virtual endpoints.",
            "old": "The list of virtual endpoints"
          },
          "$items": {
            "Description": {
              "new": "Pair of virtual endpoints for a flexible server.",
              "old": "Represents a virtual endpoint for a server."
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "Link used to get the next page of results.",
            "old": "The link used to get the next page of operations."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of virtual endpoints. ,
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 ,
}
,
]
,
}
,
}