Microsoft.DBforPostgreSQL (preview:2023-03-02)

2025/08/29 • 27 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all of the available REST API operations."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
        "old": "A list of resource provider operations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of operations supported by the resource provider",
            "old": "Collection of available operation details."
          },
          "$items": {
            "Description": {
              "new": "Details of a REST API operation, returned from the Resource Provider Operations API",
              "old": "REST API operation definition."
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"",
                  "old": "The name of the operation being performed on this particular object."
                }
              },
              {
                "#name": "isDataAction",
                "Description": {
                  "new": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.",
                  "old": "Indicates whether the operation is a data action."
                }
              },
              {
                "#name": "display",
                "Description": {
                  "new": "Localized display information for this particular operation.",
                  "old": "The localized display information for this particular operation or action."
                },
                "$properties": [
                  {
                    "#name": "provider",
                    "Description": {
                      "new": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".",
                      "old": "Operation resource provider name."
                    }
                  },
                  {
                    "#name": "resource",
                    "Description": {
                      "new": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".",
                      "old": "Resource on which the operation is performed."
                    }
                  },
                  {
                    "#name": "operation",
                    "Description": {
                      "new": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".",
                      "old": "Localized friendly name for the operation."
                    }
                  },
                  {
                    "#name": "description",
                    "Description": {
                      "new": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.",
                      "old": "Operation description."
                    }
                  }
                ]
              },
              {
                "#name": "origin",
                "Description": {
                  "new": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"",
                  "old": "The intended executor of the operation."
                },
                "Enum": {
                  "new": [
                    [
                      "user",
                      ""
                    ],
                    [
                      "system",
                      ""
                    ],
                    [
                      "user,system",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "NotSpecified",
                      ""
                    ],
                    [
                      "user",
                      ""
                    ],
                    [
                      "system",
                      ""
                    ]
                  ]
                }
              },
              {
                "@added_fe9d8fa890b74ff2afa449daf9467dd8": {
                  "#name": "actionType",
                  "Description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.",
                  "Enum": [
                    [
                      "Internal",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_b1830a8b0218429588e4d596cbbc47f0": {
                  "#name": "properties",
                  "Description": "Additional descriptions for the operation.",
                  "Required": false,
                  "Type": "object"
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "URL to get the next set of operation list results (if there are any).",
            "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: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
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 ,
}
,
]
,
}
,
}
Clusters_CheckNameAvailability (updated)
Description :  Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Clusters_CheckNameAvailability",
  "$parameters": [
    {
      "#name": "nameAvailabilityRequest",
      "Description": {
        "new": "The request body",
        "old": "The required parameters for checking if cluster name is available."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: Cluster name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
Microsoft.DBforPostgreSQL/serverGroupsv2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Error message. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Indicates whether the cluster name is available. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of the cluster. ,
Required: False ,
}
string ,
type:
{
Description: Type of the cluster. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Clusters_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Cluster list operation.",
        "old": "A list of clusters."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Cluster items on this page",
            "old": "The list of clusters"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link used to get the next page of cluster list."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2
{
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 Cluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
aadAuthEnabled:
{
Description: Indicates whether the cluster was created using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
dataEncryption:
{
Description: The data encryption properties of a cluster. ,
Required: False ,
}
{
primaryKeyUri:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
type:
{
Enum:
{
AzureKeyVault: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
passwordEnabled:
{
Description: Indicates whether the cluster was created with a password or using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
]
,
databaseName:
{
Description: The database name of the cluster. Only one database per cluster is supported. ,
Required: False ,
}
string ,
enableGeoBackup:
{
Description: If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation. ,
Required: False ,
}
boolean ,
authConfig:
{
Description: Authentication configuration of a cluster. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Describes the identity of the cluster. ,
Required: False ,
}
{
type:
{
Enum:
{
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
Clusters_ListByResourceGroup (updated)
Description :  Lists all clusters in a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Clusters_ListByResourceGroup",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Cluster list operation.",
        "old": "A list of clusters."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Cluster items on this page",
            "old": "The list of clusters"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link used to get the next page of cluster list."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2
{
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 Cluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
aadAuthEnabled:
{
Description: Indicates whether the cluster was created using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
dataEncryption:
{
Description: The data encryption properties of a cluster. ,
Required: False ,
}
{
primaryKeyUri:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
type:
{
Enum:
{
AzureKeyVault: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
passwordEnabled:
{
Description: Indicates whether the cluster was created with a password or using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
]
,
databaseName:
{
Description: The database name of the cluster. Only one database per cluster is supported. ,
Required: False ,
}
string ,
enableGeoBackup:
{
Description: If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation. ,
Required: False ,
}
boolean ,
authConfig:
{
Description: Authentication configuration of a cluster. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Describes the identity of the cluster. ,
Required: False ,
}
{
type:
{
Enum:
{
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
Clusters_Create (updated)
Description :  Creates a new cluster with servers.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Clusters_Create",
  "$responses": {
    "201": [
      {
        "@added_2bacf576d3164fb7ad268c39c156bae9": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_dc02b6ad6ca0470e9a9241fd70a944ba": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a cluster. ,
Required: True ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
aadAuthEnabled:
{
Description: Indicates whether the cluster was created using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
dataEncryption:
{
Description: The data encryption properties of a cluster. ,
Required: False ,
}
{
primaryKeyUri:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
type:
{
Enum:
{
AzureKeyVault: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
passwordEnabled:
{
Description: Indicates whether the cluster was created with a password or using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
]
,
databaseName:
{
Description: The database name of the cluster. Only one database per cluster is supported. ,
Required: False ,
}
string ,
enableGeoBackup:
{
Description: If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation. ,
Required: False ,
}
boolean ,
authConfig:
{
Description: Authentication configuration of a cluster. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Describes the identity of the cluster. ,
Required: False ,
}
{
type:
{
Enum:
{
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
aadAuthEnabled:
{
Description: Indicates whether the cluster was created using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
dataEncryption:
{
Description: The data encryption properties of a cluster. ,
Required: False ,
}
{
primaryKeyUri:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
type:
{
Enum:
{
AzureKeyVault: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
passwordEnabled:
{
Description: Indicates whether the cluster was created with a password or using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
]
,
databaseName:
{
Description: The database name of the cluster. Only one database per cluster is supported. ,
Required: False ,
}
string ,
enableGeoBackup:
{
Description: If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation. ,
Required: False ,
}
boolean ,
authConfig:
{
Description: Authentication configuration of a cluster. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Describes the identity of the cluster. ,
Required: False ,
}
{
type:
{
Enum:
{
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Represents a cluster. ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
aadAuthEnabled:
{
Description: Indicates whether the cluster was created using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
dataEncryption:
{
Description: The data encryption properties of a cluster. ,
Required: False ,
}
{
primaryKeyUri:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
type:
{
Enum:
{
AzureKeyVault: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
passwordEnabled:
{
Description: Indicates whether the cluster was created with a password or using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
]
,
databaseName:
{
Description: The database name of the cluster. Only one database per cluster is supported. ,
Required: False ,
}
string ,
enableGeoBackup:
{
Description: If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation. ,
Required: False ,
}
boolean ,
authConfig:
{
Description: Authentication configuration of a cluster. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Describes the identity of the cluster. ,
Required: False ,
}
{
type:
{
Enum:
{
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Clusters_Update (updated)
Description :  Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Clusters_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "administratorLoginPassword",
            "Description": {
              "new": "The password of the administrator login. Each cluster is created with pre-defined administrative role called \u2018citus\u2019.",
              "old": "The password of the administrator login. Each cluster is created with pre-defined administrative role called \u2018citus\u2019.\u202f"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "202": [
      {
        "@added_7ea034e926764073ae9c607dce4b9fa2": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_1d13d0094238463d95af592febb56cb1": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for updating a cluster. ,
Required: True ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLoginPassword:
{
Description: The password of the administrator login. Each cluster is created with pre-defined administrative role called ‘citus’. ,
Format: password ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
coordinatorServerEdition:
{
Description: The edition of the coordinator (default: GeneralPurpose). ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of the coordinator in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of the coordinator (max: 96). ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
identity:
{
Description: Describes the identity of the cluster. ,
Required: False ,
}
{
type:
{
Enum:
{
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
aadAuthEnabled:
{
Description: Indicates whether the cluster was created using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
dataEncryption:
{
Description: The data encryption properties of a cluster. ,
Required: False ,
}
{
primaryKeyUri:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
type:
{
Enum:
{
AzureKeyVault: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
passwordEnabled:
{
Description: Indicates whether the cluster was created with a password or using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
]
,
databaseName:
{
Description: The database name of the cluster. Only one database per cluster is supported. ,
Required: False ,
}
string ,
enableGeoBackup:
{
Description: If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation. ,
Required: False ,
}
boolean ,
authConfig:
{
Description: Authentication configuration of a cluster. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Describes the identity of the cluster. ,
Required: False ,
}
{
type:
{
Enum:
{
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Represents a cluster. ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
aadAuthEnabled:
{
Description: Indicates whether the cluster was created using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
dataEncryption:
{
Description: The data encryption properties of a cluster. ,
Required: False ,
}
{
primaryKeyUri:
{
Description: URI for the key in keyvault for data encryption of the primary server. ,
Required: False ,
}
string ,
primaryUserAssignedIdentityId:
{
Description: Resource Id for the User assigned identity to be used for data encryption of the primary server. ,
Required: False ,
}
string ,
type:
{
Enum:
{
AzureKeyVault: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
passwordEnabled:
{
Description: Indicates whether the cluster was created with a password or using AAD authentication. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
]
,
databaseName:
{
Description: The database name of the cluster. Only one database per cluster is supported. ,
Required: False ,
}
string ,
enableGeoBackup:
{
Description: If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation. ,
Required: False ,
}
boolean ,
authConfig:
{
Description: Authentication configuration of a cluster. ,
Required: False ,
}
{
activeDirectoryAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
passwordAuth:
{
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Describes the identity of the cluster. ,
Required: False ,
}
{
type:
{
Enum:
{
UserAssigned: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Clusters_Delete (updated)
Description :  Deletes a cluster together with servers in it.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Clusters_Delete",
  "$responses": {
    "202": [
      {
        "@added_501670000eba4e7a82364c24940983ab": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_700709f9e663406781560106bdf455aa": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
Configurations_ListByCluster (updated)
Description :  List all the configurations of a cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_ListByCluster",
  "$responses": {
    "200": {
      "Description": {
        "new": "Pagination result of configurations.",
        "old": "A list of cluster configurations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The list of configurations.",
            "old": "The list of cluster configurations."
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of results.",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of configuration. ,
Required: False ,
}
{
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
serverRoleGroupConfigurations:
{
Description: The list of server role group configuration values. ,
Required: True ,
}
[
{
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the configuration ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to 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_UpdateOnCoordinator (updated)
Description :  Updates configuration of coordinator in a cluster
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_UpdateOnCoordinator",
  "$responses": {
    "201": [
      {
        "@added_f0b96a657f2c44758d0cc0a537dd6ef6": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_1b94c61b55be40e8aacfd659a7799d82": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/coordinatorConfigurations/{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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the cluster configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Represents a configuration. ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FirewallRules_ListByCluster (updated)
Description :  Lists all the firewall rules on cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FirewallRules_ListByCluster",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a FirewallRule list operation.",
        "old": "A list of firewall rules."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The FirewallRule items on this page",
            "old": "The list of firewall rules in a cluster."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_607c7ef02c0f4e82ae2793a39eefbf2e": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The FirewallRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the firewall rule. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 cluster firewall rule or updates an existing cluster firewall rule.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FirewallRules_CreateOrUpdate",
  "$responses": {
    "201": [
      {
        "@added_2de5360cec6c4a0d8e3771614f68cedd": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_8d9a9afb81344889ba038be0b4330a10": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the cluster firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a firewall rule. ,
Required: True ,
}
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the firewall rule. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the firewall rule. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Represents a cluster firewall rule. ,
}
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the firewall rule. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "FirewallRules_Delete",
  "$responses": {
    "202": [
      {
        "@added_a00ccd3516154d95b5bcc6cf3ed059d6": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_af0fbfcdf7d34643b88669c833239007": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
Configurations_UpdateOnNode (updated)
Description :  Updates configuration of worker nodes in a cluster
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_UpdateOnNode",
  "$responses": {
    "201": [
      {
        "@added_4453202d6737427ebadadc8cc7a6dfa2": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_2798b94d3078487b8e907e3d7c38c10c": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/nodeConfigurations/{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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the cluster configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Represents a configuration. ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByCluster (updated)
Description :  Gets list of private endpoint connections on a cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByCluster",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateEndpointConnection list operation.",
        "old": "List of private endpoint connections associated with the specified resource."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateEndpointConnection items on this page",
            "old": "Array of private endpoint connections."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_21851f6e442447ba8be734cf76008181": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnection items on this page ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (updated)
Description :  Gets private endpoint connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Get",
  "$parameters": [
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name of the private endpoint connection associated with the Azure resource.",
        "old": "The name of the private endpoint connection associated with the cluster."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚶ Changes

{
  "#id": "PrivateEndpointConnections_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name of the private endpoint connection associated with the Azure resource.",
        "old": "The name of the private endpoint connection associated with the cluster."
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "Resource create parameters.",
        "old": "The required parameters for approving a private endpoint connection."
      }
    }
  ],
  "$responses": {
    "201": [
      {
        "@added_8853d20d5bec49fb93c00375f8234a4b": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_33e5b709c73a43c2832cfcec2bf6d573": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Resource create parameters. ,
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)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: The private endpoint connection resource. ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Delete",
  "$parameters": [
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name of the private endpoint connection associated with the Azure resource.",
        "old": "The name of the private endpoint connection associated with the cluster."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_5de8db44e0224f81b5da7cb10465c749": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_1be223c316454c8280f6b8ecff98258d": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByCluster (updated)
Description :  Gets the private link resources for cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateLinkResources_ListByCluster",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateLinkResource list operation.",
        "old": "A list of private link resources."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateLinkResource items on this page",
            "old": "Array of private link resources"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_c47243dbef214c01879575aa6f28bba0": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The PrivateLinkResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
Clusters_PromoteReadReplica (updated)
Description :  Promotes read replica cluster to an independent read-write cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Clusters_PromoteReadReplica",
  "$responses": {
    "202": [
      {
        "@added_f1ca8fb0151d4266a9af4a6657ed6d38": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_ee3ea7c6a3054dddb0521c4c78e4e24b": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/promote
{
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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
promoteRequest:
{
Description: The parameter for enabling geo-redundant backup while promoting read replica. ,
Required: False ,
}
{
enableGeoBackup:
{
Description: Boolean property to enable geo-redundant replica promotion. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
Clusters_Restart (updated)
Description :  Restarts all nodes in the cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Clusters_Restart",
  "$responses": {
    "202": [
      {
        "@added_06ee3912326b418687fc8355763c9586": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_b5fa86234b6e4bc8b70600befc24cdce": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
Roles_ListByCluster (updated)
Description :  List all the roles in a given cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Roles_ListByCluster",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Role list operation.",
        "old": "A list of roles."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Role items on this page",
            "old": "The list of roles in a cluster."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_f99ca420f746438194673bce40bb43b7": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles
{
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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Role items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
roleType:
{
Enum:
{
user: No description available. ,
admin: No description available. ,
}
,
Required: False ,
}
enum ,
password:
{
Description: The password of the cluster role. If an identity is used, password will not be required. ,
Format: password ,
Required: False ,
}
string ,
externalIdentity:
{
Required: False ,
}
{
objectId:
{
Description: A type definition that refers the id to an Azure Resource Manager resource. ,
Format: arm-id ,
Required: True ,
}
string ,
principalType:
{
Enum:
{
user: No description available. ,
servicePrincipal: No description available. ,
group: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: A type definition that refers the id to an Azure Resource Manager resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
Roles_Create (updated)
Description :  Creates a new role or updates an existing role.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Roles_Create",
  "$responses": {
    "201": [
      {
        "@added_b2096a21a63d44dcb3f4c54ee4c660f4": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_75046c7aa3eb4819919d281497791b2c": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}
{
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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
roleName:
{
Description: The name of the cluster role. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a role. ,
Required: True ,
}
{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
roleType:
{
Enum:
{
user: No description available. ,
admin: No description available. ,
}
,
Required: False ,
}
enum ,
password:
{
Description: The password of the cluster role. If an identity is used, password will not be required. ,
Format: password ,
Required: False ,
}
string ,
externalIdentity:
{
Required: False ,
}
{
objectId:
{
Description: A type definition that refers the id to an Azure Resource Manager resource. ,
Format: arm-id ,
Required: True ,
}
string ,
principalType:
{
Enum:
{
user: No description available. ,
servicePrincipal: No description available. ,
group: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: A type definition that refers the id to an Azure Resource Manager resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
roleType:
{
Enum:
{
user: No description available. ,
admin: No description available. ,
}
,
Required: False ,
}
enum ,
password:
{
Description: The password of the cluster role. If an identity is used, password will not be required. ,
Format: password ,
Required: False ,
}
string ,
externalIdentity:
{
Required: False ,
}
{
objectId:
{
Description: A type definition that refers the id to an Azure Resource Manager resource. ,
Format: arm-id ,
Required: True ,
}
string ,
principalType:
{
Enum:
{
user: No description available. ,
servicePrincipal: No description available. ,
group: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: A type definition that refers the id to an Azure Resource Manager resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Represents a cluster role. ,
}
{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
roleType:
{
Enum:
{
user: No description available. ,
admin: No description available. ,
}
,
Required: False ,
}
enum ,
password:
{
Description: The password of the cluster role. If an identity is used, password will not be required. ,
Format: password ,
Required: False ,
}
string ,
externalIdentity:
{
Required: False ,
}
{
objectId:
{
Description: A type definition that refers the id to an Azure Resource Manager resource. ,
Format: arm-id ,
Required: True ,
}
string ,
principalType:
{
Enum:
{
user: No description available. ,
servicePrincipal: No description available. ,
group: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: A type definition that refers the id to an Azure Resource Manager resource. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Roles_Delete",
  "$responses": {
    "202": [
      {
        "@added_0570a9a04eab4907a4bfa3de71b3d3b9": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_add8fd47db0a418c9e57801d5778e832": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}
{
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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
roleName:
{
Description: The name of the cluster role. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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_ListByCluster (updated)
Description :  Lists servers of a cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Servers_ListByCluster",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a ClusterServer list operation.",
        "old": "A list of servers in a cluster."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ClusterServer items on this page",
            "old": "The list of servers in a cluster."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_e9cffe45920942fbb2cb7e1c08272e1b": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers
{
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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ClusterServer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of a server in a cluster. ,
Required: False ,
}
{
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
role:
{
Description: The role of server in the cluster. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
haState:
{
Description: A state of HA feature for the cluster. ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability Zone information of the server. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version of server. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version of server. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_ListByServer (updated)
Description :  List all the configurations of a server in cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Configurations_ListByServer",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a ServerConfiguration list operation.",
        "old": "A list of server configurations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ServerConfiguration items on this page",
            "old": "The list of server configurations."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to retrieve next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The ServerConfiguration items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
Clusters_Start (updated)
Description :  Starts stopped compute on all cluster nodes.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Clusters_Start",
  "$responses": {
    "202": [
      {
        "@added_7f36aeb255e849c99abba8db42c8c193": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_6b3921138b0f4bd69f1ea1e642072a85": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}
Clusters_Stop (updated)
Description :  Stops compute on all cluster nodes.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Clusters_Stop",
  "$responses": {
    "202": [
      {
        "@added_650ba94bc25e42a6ad8f39f3a7773d5b": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@removed_844d3a9b541c4eaaab227dd4c23b3d9e": {
          "#name": "azure-async-operation",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/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 ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
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 ,
}
,
]
,
}
,
}